Simple and complete React DOM testing utilities that encourage good testing practices.
Table of Contents
- The problem
- This solution
- Other Solutions
- Guiding Principles
You want to write maintainable tests for your React components. As a part of this goal, you want your tests to avoid including implementation details of your components and rather focus on making your tests give you the confidence for which they are intended. As part of this, you want your testbase to be maintainable in the long run so refactors of your components (changes to implementation but not functionality) don't break your tests and slow you and your team down.
react-testing-library is a very lightweight solution for testing React
components. It provides light utility functions on top of
react-dom/test-utils, in a way that encourages better testing practices. Its
primary guiding principle is:
// __tests__/fetch.js// this adds custom jest matchers from jest-dom// the mock lives in a __mocks__ directory// to know more about manual mocks, access:// automatically unmount and cleanup DOM after the test is finished.
npm install --save-dev react-testing-library
This library has
peerDependencies listings for
You may also be interested in installing
jest-dom so you can use
the custom jest matchers.
We're in the process of moving examples to the docs site
You'll find runnable examples of testing with different libraries in
Some included are:
You can also find react-testing-library examples at react-testing-examples.com.
If you are interested in testing a custom hook, check out react-hooks-testing-library
We try to only expose methods and utilities that encourage you to write tests that closely resemble how your react components are used.
Utilities are included in this project based on the following guiding principles:
- If it relates to rendering components, it deals with DOM nodes rather than component instances, nor should it encourage dealing with component instances.
- It should be generally useful for testing individual React components or
full React applications. While this library is focused on
react-dom, utilities could be included even if they don't directly relate to
- Utility implementations and APIs should be simple and flexible.
At the end of the day, what we want is for this library to be pretty light-weight, simple, and understandable.
Thanks goes to these people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!
Looking to contribute? Look for the Good First Issue label.
Please file an issue for bugs, missing documentation, or unexpected behavior.
💡 Feature Requests
Please file an issue to suggest new features. Vote on feature requests by adding a 👍. This helps maintainers prioritize what to work on.
For questions related to using the library, please visit a support community instead of filing an issue on GitHub.