diff --git a/docs/react-testing-library/api.mdx b/docs/react-testing-library/api.mdx index 06149fed..449c76f5 100644 --- a/docs/react-testing-library/api.mdx +++ b/docs/react-testing-library/api.mdx @@ -16,6 +16,7 @@ as these methods: - [`onRecoverableError`](#onrecoverableerror) - [`wrapper`](#wrapper) - [`queries`](#queries) + - [`reactStrictMode`](#render-options-reactstrictmode) - [`render` Result](#render-result) - [`...queries`](#queries-1) - [`container`](#container-1) @@ -31,7 +32,8 @@ as these methods: - [`initialProps`](#initialprops) - [`onCaughtError`](#oncaughterror) - [`onRecoverableError`](#onrecoverableerror) - - [`wrapper`](#wrapper-1) + - [`wrapper`](#renderhook-options-wrapper) + - [`reactStrictMode`](#renderhook-options-reactstrictmode) - [`renderHook` Result](#renderhook-result) - [`result`](#result) - [`rerender`](#rerender-1) @@ -161,6 +163,11 @@ utility functions to create custom queries. Custom queries can also be added globally by following the [custom render guide](setup.mdx#custom-render). +### `render` Options `reactStrictMode` + +When enabled, [``](https://react.dev/reference/react/StrictMode) is rendered around the inner element. +If defined, overrides the value of `reactStrictMode` set in [`configure`](https://testing-library.com/docs/react-testing-library/api/#configure-options). + ## `render` Result The `render` method returns an object that has a few properties: @@ -431,6 +438,11 @@ Behaves the same as [`onRecoverableError` in `ReactDOMClient.createRoot`](https: See [`wrapper` option for `render`](#wrapper) + +### `renderHook` Options `reactStrictMode` + +See [`reactStrictMode` option for `render`](#render-options-reactstrictmode) + ## `renderHook` Result The `renderHook` method returns an object that has a few properties: @@ -503,3 +515,5 @@ configure({reactStrictMode: true}) When enabled, [``](https://react.dev/reference/react/StrictMode) is rendered around the inner element. Defaults to `false`. + +This setting can be changed for a single test by providing `reactStrictMode` in the options argument of the [`render`](#render-options-reactstrictmode) function. \ No newline at end of file