Skip to content

docs: update the rerender method using the unmount method before #1015

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

Closed
wants to merge 1 commit into from
Closed

docs: update the rerender method using the unmount method before #1015

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 6 additions & 1 deletion docs/react-testing-library/api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,10 +207,15 @@ to ensure that the props are being updated correctly (see
prefer to update the props of a rendered component in your test, this function
can be used to update props of the rendered component.

To use rerender it is necessary to use the unmount method to undo the previous rendering context.

```jsx
import {render} from '@testing-library/react'

const {rerender} = render(<NumberDisplay number={1} />)
const {rerender, unmount} = render(<NumberDisplay number={1} />)

// this will cause the rendered component to be unmounted
unmount()

// re-render the same component with different props
rerender(<NumberDisplay number={2} />)
Expand Down