Skip to content

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
merged 3 commits into from
Aug 9, 2022
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions docs/react-testing-library/setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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'}, ]}>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Nit]
Maybe we should write Javascript and Typescript with a capital s?
(Not sure we're following this rule in other places also, so this really isn't important)


<TabItem value="js">

```js title="custom-queries.js"
import { queryHelpers, buildQueries } from '@testing-library/react'

Expand Down Expand Up @@ -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.

Expand Down