testing-library/react-testing-library

💡 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.

Installation

This module is distributed via [npm][npm] which is bundled with [node][node] and should be installed as one of your project's devDependencies. Starting from RTL version 16, you'll also need to install @testing-library/dom:

This library has peerDependencies listings for react, react-dom and starting from RTL version 16 also @testing-library/dom.

React Testing Library versions 13+ require React v18. If your project uses an older version of React, be sure to install version 12:

You may also be interested in installing @testing-library/jest-dom so you can use the custom jest matchers.

npm install --save-dev @testing-library/react @testing-library/dom

Basic Example

// hidden-message.js
import * as React from 'react'

// NOTE: React Testing Library works well with React Hooks and classes.
// Your tests will be the same regardless of how you write your components.
function HiddenMessage({children}) {
  const [showMessage, setShowMessage] = React.useState(false)
  return (
    <div>
      <label htmlFor="toggle">Show Message</label>
      <input
        id="toggle"
        type="checkbox"
        onChange={e => setShowMessage(e.target.checked)}
        checke

Complex Example

// login.js
import * as React from 'react'

function Login() {
  const [state, setState] = React.useReducer((s, a) => ({...s, ...a}), {
    resolved: false,
    loading: false,
    error: null,
  })

  function handleSubmit(event) {
    event.preventDefault()
    const {usernameInput, passwordInput} = event.target.elements

    setState({loading: true, resolved: false, error: null})

    window
      .fetch('/api/login', {
        method: 'POST',
        headers: {'Content-Type': 'application/js

More Examples

You'll find runnable examples of testing with different libraries in the react-testing-library-examples codesandbox. Some included are:

• react-redux
• react-router
• react-context

Guiding Principles

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:

Most importantly, we want React Testing Library to be pretty light-weight, simple, and easy to understand.

• 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
• react-dom.
• Utility implementations and APIs should be simple and flexible.

Table of Contents

• The problem
• The solution
• Installation
• Suppressing unnecessary warnings on React DOM 16.8
• Basic Example
• Complex Example
• More Examples
• Guiding Principles
• 💡 Feature Requests
• ❓ Questions
• Contributors

概述

Simple and complete React DOM testing utilities that encourage good testing practices.

The problem

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.