react-native-testing-library

Simple React Native testing utilities helping you write better tests with less effort

Github星跟踪图

Version
PRs Welcome
Chat
Greenkeeper badge
Sponsored by Callstack

Appreciation notice: This project is heavily inspired by react-testing-library. Go check it out and use it to test your web React apps.

The problem

You want to write maintainable tests for your React Native components without testing implementation details, but then you're told to use Enzyme, which you learn has no React Native adapter, meaning only shallow rendering is supported. And you want to render deep! But deep rendering may otherwise require jsdom (React Native isn't the web!), while doing deep rendering with react-test-renderer is so painful.

You would also like to use the newest React features, but you need to wait for your testing library's abstractions to catch up and it takes a while.

You finally want to approach testing using only best practices, while Enzyme may encourage assertions on implementation details.

This solution

The react-native-testing-library is a lightweight solution for testing your React Native components. It provides light utility functions on top of react-test-renderer letting you always be up to date with latest React features and write any component tests you like. But really not any, it prevents you from testing implementation details because we stand this is a very bad practice.

This library is a replacement for Enzyme. It is tested to work with Jest, but it should work with other test runners as well.

Example

import { render, fireEvent } from 'react-native-testing-library';
import { QuestionsBoard } from '../QuestionsBoard';
import { Question } from '../Question';

function setAnswer(question, answer) {
  fireEvent.changeText(question, answer);
}

test('should verify two questions', () => {
  const { getAllByA11yRole, getByText } = render(<QuestionsBoard {...props} />);
  const allQuestions = getAllByA11yRole('header');

  setAnswer(allQuestions[0], 'a1');
  setAnswer(allQuestions[1], 'a2');

  fireEvent.press(getByText('submit'));

  expect(props.verifyQuestions).toBeCalledWith({
    '1': { q: 'q1', a: 'a1' },
    '2': { q: 'q2', a: 'a2' },
  });
});

Installation

Open a Terminal in your project's folder and run:

yarn add --dev react-native-testing-library

This library has a peerDependencies listing for react-test-renderer and, of course, react. Make sure to install them too!

Note for Flow users – you'll also need to install typings for react-test-renderer:

flow-typed install react-test-renderer

As you may have noticed, it's not tied to React Native at all – you can safely use it in your React components if you feel like not interacting directly with DOM.

API / Usage

The public API of react-native-testing-library is focused around these essential methods:

  • render – deeply renders given React element and returns helpers to query the output components.
  • fireEvent - invokes named event handler on the element.
  • waitForElement - waits for non-deterministic periods of time until your element appears or times out.
  • flushMicrotasksQueue - waits for microtasks queue to flush.

Note to users who are more familiar with react-testing-library: This API does not expose cleanup because it doesn't interact with the DOM. There's nothing to clean up.

Made with ❤️ at Callstack

React Native Testing Library is an open source project and will always remain free to use. If you think it's cool, please star it ?. Callstack is a group of React and React Native geeks, contact us at hello@callstack.com if you need any help with these or just want to say hi!


Supported and used by Rally Health.

主要指标

概览
名称与所有者callstack/react-native-testing-library
主编程语言TypeScript
编程语言JavaScript (语言数: 4)
平台
许可证MIT License
所有者活动
创建于2018-10-01 14:32:13
推送于2025-07-22 15:23:38
最后一次提交
发布数113
最新版本名称v14.0.0-alpha.1 (发布于 2025-03-10 19:01:31)
第一版名称v0.1.0 (发布于 )
用户参与
星数3.2k
关注者数29
派生数276
提交数1.1k
已启用问题?
问题数519
打开的问题数8
拉请求数946
打开的拉请求数6
关闭的拉请求数285
项目设置
已启用Wiki?
已存档?
是复刻?
已锁定?
是镜像?
是私有?