-
Notifications
You must be signed in to change notification settings - Fork 727
docs: add TypeScript example for custom-queries.js #893
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Changes from 2 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -155,6 +155,11 @@ elements by `data-cy`, a "test ID" convention mentioned in the | |
[Cypress.io](https://docs.cypress.io/guides/references/best-practices.html#Selecting-Elements) | ||
documentation. | ||
|
||
<Tabs groupId="test-utils" defaultValue="js" values={[ {label: 'Javascript', | ||
value: 'js'}, {label: 'Typescript', value: 'ts'}, ]}> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [Nit]
eps1lon marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
<TabItem value="js"> | ||
|
||
```js title="custom-queries.js" | ||
import { queryHelpers, buildQueries } from '@testing-library/react' | ||
|
||
|
@@ -187,6 +192,54 @@ export { | |
} | ||
``` | ||
|
||
</TabItem> | ||
|
||
<TabItem value="ts"> | ||
|
||
```ts title="custom-queries.ts" | ||
import { | ||
queryHelpers, | ||
buildQueries, | ||
Matcher, | ||
MatcherOptions, | ||
} from '@testing-library/react' | ||
|
||
// The queryAllByAttribute is a shortcut for attribute-based matchers | ||
// You can also use document.querySelector or a combination of existing | ||
// testing library utilities to find matching nodes for your query | ||
const queryAllByDataCy = ( | ||
container: HTMLElement, | ||
id: Matcher, | ||
options?: MatcherOptions | undefined | ||
) => queryHelpers.queryAllByAttribute('data-cy', container, id, options) | ||
|
||
const getMultipleError = (c, dataCyValue) => | ||
`Found multiple elements with the data-cy attribute of: ${dataCyValue}` | ||
const getMissingError = (c, dataCyValue) => | ||
`Unable to find an element with the data-cy attribute of: ${dataCyValue}` | ||
|
||
const [ | ||
queryByDataCy, | ||
getAllByDataCy, | ||
getByDataCy, | ||
findAllByDataCy, | ||
findByDataCy, | ||
] = buildQueries(queryAllByDataCy, getMultipleError, getMissingError) | ||
|
||
export { | ||
queryByDataCy, | ||
queryAllByDataCy, | ||
getByDataCy, | ||
getAllByDataCy, | ||
findAllByDataCy, | ||
findByDataCy, | ||
} | ||
``` | ||
|
||
</TabItem> | ||
|
||
</Tabs> | ||
|
||
You can then override and append the new queries via the render function by | ||
passing a [`queries`](api.mdx#render-options) option. | ||
|
||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.