Skip to content

Add reactStrictMode option for RTL #1318

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 3 commits into from
Jan 30, 2024
Merged

Add reactStrictMode option for RTL #1318

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aa6cbca
docs: add `configure` functions and options for RTL
yinm Oct 8, 2023
48f3b1f
docs: change link for RTL's `configure`
yinm Oct 8, 2023
e2783d1
Merge branch 'main' into pr/add-reactStrictMode-option
eps1lon Jan 30, 2024
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
23 changes: 23 additions & 0 deletions docs/react-testing-library/api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ as these methods:
- [`result`](#result)
- [`rerender`](#rerender-1)
- [`unmount`](#unmount-1)
- [`configure`](#configure)
- [`configure` Options](#configure-options)

---

Expand Down Expand Up @@ -451,3 +453,24 @@ const {unmount} = renderHook(({name = 'Alice'} = {}) => name)

unmount()
```

## `configure`

Changes global options. Basic usage can be seen at
[Configuration Options](dom-testing-library/api-configuration.mdx).

React Testing Library also has dedicated options.

```typescript
import {configure} from '@testing-library/react'

configure({reactStrictMode: true})
```

## `configure` Options

### `reactStrictMode`

When enabled, [`<StrictMode>`](https://react.dev/reference/react/StrictMode) is
rendered around the inner element. Defaults to `false`.

2 changes: 1 addition & 1 deletion docs/react-testing-library/cheatsheet.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ See [Events API](dom-testing-library/api-events.mdx)
## Other

See [Querying Within Elements](dom-testing-library/api-within.mdx),
[Config API](dom-testing-library/api-configuration.mdx),
[Config API](react-testing-library/api.mdx#configure),
[Cleanup](react-testing-library/api.mdx#cleanup),

- **within** take a node and return an object with all the queries bound to the
Expand Down