Skip to content

Update setup.mdx #1191

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.

Sign up for GitHub

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 5 commits into from
Dec 29, 2022
Merged

Update setup.mdx #1191

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
71c1dcb
Update setup.mdx
wtlin1228 Dec 14, 2022
c9705f2
Update docs/react-testing-library/setup.mdx
wtlin1228 Dec 17, 2022
35bf4bb
docs: make customScreen from allQueries
wtlin1228 Dec 24, 2022
7e2099b
docs: update the ts part of customScreen
wtlin1228 Dec 24, 2022
fb9eda2
docs: reorder the exports for customRender
wtlin1228 Dec 24, 2022
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
38 changes: 30 additions & 8 deletions docs/react-testing-library/setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,44 +247,66 @@ export {
You can then override and append the new queries via the render function by
passing a [`queries`](api.mdx#render-options) option.

If you want to add custom queries globally, you can do this by defining a custom
render method:
If you want to add custom queries globally, you can do this by defining your customized
`render`, `screen` and `within` methods:

<Tabs groupId="test-utils" defaultValue="jsx" values={[ {label: 'Javascript',
value: 'jsx'}, {label: 'Typescript', value: 'tsx'}, ]}>

<TabItem value="jsx">

```js title="test-utils.js"
import {render, queries} from '@testing-library/react'
import {render, queries, within} from '@testing-library/react'
import * as customQueries from './custom-queries'

const allQueries = {
...queries,
...customQueries,
}

const customScreen = within(document.body, allQueries)
const customWithin = element => within(element, allQueries)
const customRender = (ui, options) =>
render(ui, {queries: {...queries, ...customQueries}, ...options})
render(ui, {queries: allQueries, ...options})

// re-export everything
export * from '@testing-library/react'

// override render method
export {customRender as render}
export {
customScreen as screen,
customWithin as within,
customRender as render,
}
```

</TabItem>

<TabItem value="tsx">

```ts title="test-utils.ts"
import {render, queries, RenderOptions} from '@testing-library/react'
import {render, queries, within, RenderOptions} from '@testing-library/react'
import * as customQueries from './custom-queries'
import {ReactElement} from 'react'

const allQueries = {
...queries,
...customQueries,
}

const customScreen = within(document.body, allQueries)
const customWithin = (element: ReactElement) => within(element, allQueries)
const customRender = (
ui: ReactElement,
options?: Omit<RenderOptions, 'queries'>,
) => render(ui, {queries: {...queries, ...customQueries}, ...options})
) => render(ui, {queries: allQueries, ...options})

export * from '@testing-library/react'
export {customRender as render}
export {
customScreen as screen,
customWithin as within,
customRender as render,
}
```

</TabItem>
Expand Down