Skip to content

docs: use warning admonition for legacyRoot #1381

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 2 commits into from
Apr 8, 2024
Merged

docs: use warning admonition for legacyRoot #1381

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dfa9df0
docs: use warning admonition for `legacyRoot`
MatanBobi Apr 8, 2024
b59b730
fix admonition
MatanBobi Apr 8, 2024
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
9 changes: 6 additions & 3 deletions docs/react-testing-library/api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,11 @@ your components.

### `legacyRoot`

**WARNING**: This option is only available when tests run with React 18 and earlier.
:::warning

This option is only available when tests run with React 18 and earlier.

:::

By default we'll render with support for concurrent features (i.e.
[`ReactDOMClient.createRoot`](https://reactjs.org/docs/react-dom-client.html#createroot)).
Expand Down Expand Up @@ -342,7 +346,7 @@ function renderHook<
Props,
Q extends Queries = typeof queries,
Container extends Element | DocumentFragment = HTMLElement,
BaseElement extends Element | DocumentFragment = Container,
BaseElement extends Element | DocumentFragment = Container
>(
render: (initialProps: Props) => Result,
options?: RenderHookOptions<Props, Q, Container, BaseElement>,
Expand Down Expand Up @@ -475,4 +479,3 @@ configure({reactStrictMode: true})

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