Skip to content

Commit 4ecea96

Browse files
authored
Update RTR readme (#28705)
1 parent ba5496d commit 4ecea96

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

packages/react-test-renderer/README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,26 @@
1-
# `react-test-renderer`
1+
# `react-test-renderer` (DEPRECATED)
2+
3+
## Deprecation notice
4+
5+
`react-test-renderer` is deprecated and no longer maintained. It will be removed in a future version. As of React 19, you will see a console warning when invoking `ReactTestRenderer.create()`.
6+
7+
### React Testing
8+
9+
This library creates a contrived environment and its APIs encourage introspection on React's internals, which may change without notice causing broken tests. It is instead recommended to use browser-based environments such as jsdom and standard DOM APIs for your assertions.
10+
11+
The React team recommends [`@testing-library/react`](https://testing-library.com/docs/react-testing-library/intro) as a modern alternative that uses standard APIs, avoids internals, and [promotes best practices](https://testing-library.com/docs/guiding-principles).
12+
13+
### React Native Testing
14+
15+
The React team recommends @testing-library/react-native as a replacement for `react-test-renderer` for native integration tests. This React Native testing-library variant follows the same API design as described above and promotes better testing patterns.
16+
17+
## Documentation
218

319
This package provides an experimental React renderer that can be used to render React components to pure JavaScript objects, without depending on the DOM or a native mobile environment.
420

521
Essentially, this package makes it easy to grab a snapshot of the "DOM tree" rendered by a React DOM or React Native component without using a browser or jsdom.
622

7-
Documentation:
8-
9-
[https://reactjs.org/docs/test-renderer.html](https://reactjs.org/docs/test-renderer.html)
23+
Documentation: [https://reactjs.org/docs/test-renderer.html](https://reactjs.org/docs/test-renderer.html)
1024

1125
Usage:
1226

0 commit comments

Comments
 (0)