Skip to content
Back to search

react-native-testing-library

🦉 Simple and complete React Native testing utilities that encourage good testing practices.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/callstack-react-native-testing-library/badge.svg)](/listings/callstack-react-native-testing-library)

HTML

<a href="/listings/callstack-react-native-testing-library"><img src="/api/listings/callstack-react-native-testing-library/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

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

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

This library has a `peerDependencies` listing for [Test Renderer](https://github.com/mdjastrzebski/test-renderer). Make sure to install it as a dev dependency:

npm install --save-dev test-renderer

Additional Jest matchers

You can use the built-in Jest matchers automatically by having any import from `@testing-library/react-native` in your test.

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 130 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. <div align="center">
  2. <a href="https://www.callstack.com/open-source?utm_campaign=generic&utm_source=github&utm_medium=referral&utm_content=react-native-testing-library" align="center">
  3. <img src="https://github.com/user-attachments/assets/4d452312-4ffd-4439-855f-a9b12ad7d6c2" alt="React Native Testing Library" />
  4. </a>
  5. <p align="center">Developer-friendly and complete React Native testing utilities that encourage good testing practices.</p>
  6. </div>
  7. [![Version][version-badge]][package]
  8. [![Build Status][build-badge]][build]
  9. [![Code Coverage][coverage-badge]][coverage]
  10. [![Downloads][downloads-badge]][downloads]
  11. [![MIT License][license-badge]][license]
  12. [![Sponsored by Callstack][callstack-badge]][callstack]
  13. ## The problem
  14. You want to write maintainable tests for your React Native components. Your tests should avoid implementation details and focus on giving you confidence. They should remain maintainable so refactors (changes to implementation but not functionality) don't break your tests and slow you and your team down.
  15. ## This solution
  16. The React Native Testing Library (RNTL) tests React Native components. It simulates the React Native runtime on top of [Test Renderer](https://github.com/mdjastrzebski/test-renderer) and encourages better testing practices. Its primary guiding principle is:
  17. > The more your tests resemble the way your software is used, the more confidence they can give you.
  18. This project is inspired by [React Testing Library](https://github.com/testing-library/react-testing-library). Tested to work with Jest, but it should work with other test runners as well.
  19. ## Installation
  20. Open a Terminal in your project's folder and run:
  21. ```sh
  22. npm install --save-dev @testing-library/react-native
  23. ```
  24. This library has a `peerDependencies` listing for [Test Renderer](https://github.com/mdjastrzebski/test-renderer). Make sure to install it as a dev dependency:
  25. ```sh
  26. npm install --save-dev test-renderer
  27. ```
  28. ### Additional Jest matchers
  29. You can use the built-in Jest matchers automatically by having any import from `@testing-library/react-native` in your test.
  30. ## Example
  31. ```jsx
  32. import { render, screen, userEvent } from '@testing-library/react-native';
  33. import { QuestionsBoard } from '../QuestionsBoard';
  34. test('form submits two answers', async () => {
  35. const questions = ['q1', 'q2'];
  36. const onSubmit = jest.fn();
  37. const user = userEvent.setup();
  38. await render(<QuestionsBoard questions={questions} onSubmit={onSubmit} />);
  39. const answerInputs = screen.getAllByLabelText('answer input');
  40. // simulates the user focusing on TextInput and typing text one char at a time
  41. await user.type(answerInputs[0], 'a1');
  42. await user.type(answerInputs[1], 'a2');
  43. // simulates the user pressing on any pressable element
  44. await user.press(screen.getByRole('button', { name: 'Submit' }));
  45. expect(onSubmit).toHaveBeenCalledWith({
  46. 1: { q: 'q1', a: 'a1' },
  47. 2: { q: 'q2', a: 'a2' },
  48. });
  49. });
  50. ```
  51. You can find the source of `QuestionsBoard` component and this example [here](https://github.com/callstack/react-native-testing-library/blob/main/src/__tests__/questionsBoard.test.tsx).
  52. ## API / Usage
  53. React Native Testing Library consists of following APIs:
  54. - [`render` function](https://oss.callstack.com/react-native-testing-library/docs/api/render) - render your UI components for testing purposes
  55. - [`screen` object](https://oss.callstack.com/react-native-testing-library/docs/api/screen) - access rendered UI:
  56. - [Queries](https://oss.callstack.com/react-native-testing-library/docs/api/queries) - find rendered components by various predicates: role, text, test ids, etc
  57. - Lifecycle methods: [`rerender`](https://oss.callstack.com/react-native-testing-library/docs/api/screen#rerender), [`unmount`](https://oss.callstack.com/react-native-testing-library/docs/api/screen#unmount)
  58. - Helpers: [`debug`](https://oss.callstack.com/react-native-testing-library/docs/api/screen#debug), [`toJSON`](https://oss.callstack.com/react-native-testing-library/docs/api/screen#tojson), [`root`](https://oss.callstack.com/react-native-testing-library/docs/api/screen#root), [`container`](https://oss.callstack.com/react-native-testing-library/docs/api/screen#container)
  59. - [Jest matchers](https://oss.callstack.com/react-native-testing-library/docs/api/jest-matchers) - validate assumptions about your UI
  60. - [User Event](https://oss.callstack.com/react-native-testing-library/docs/api/events/user-event) - simulate common user interactions like [`press`](https://oss.callstack.com/react-native-testing-library/docs/api/events/user-event#press) or [`type`](https://oss.callstack.com/react-native-testing-library/docs/api/events/user-event#type)
  61. - [Fire Event](https://oss.callstack.com/react-native-testing-library/docs/api/events/fire-event) - simulate any component event
  62. - [`renderHook` function](https://oss.callstack.com/react-native-testing-library/docs/api/misc/render-hook) - render hooks for testing purposes
  63. - Miscellaneous APIs:
  64. - [Async utils](https://oss.callstack.com/react-native-testing-library/docs/api/misc/async): `findBy*` queries, `waitFor`, `waitForElementToBeRemoved`
  65. - [Configuration](https://oss.callstack.com/react-native-testing-library/docs/api/misc/config): `configure`, `resetToDefaults`
  66. - [Accessibility](https://oss.callstack.com/react-native-testing-library/docs/api/misc/accessibility): `isHiddenFromAccessibility`
  67. - [Other](https://oss.callstack.com/react-native-testing-library/docs/api/misc/other): `within`, `act`, `cleanup`
  68. ## Migration Guides
  69. - **[Migration to 14.0](https://oss.callstack.com/react-native-testing-library/docs/start/migration-v14)** - Drops React 18, async APIs by default
  70. ## Troubleshooting
  71. - [Troubleshooting guide](https://oss.callstack.com/react-native-testing-library/docs/guides/troubleshooting)
  72. ## Community Resources
  73. Check out our list of [Community Resources about RNTL](https://oss.callstack.com/react-native-testing-library/docs/guides/community-resources).
  74. ## Made with ❤️ at Callstack
  75. 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](https://callstack.com) is a group of React and React Native geeks, contact us at [hello@callstack.com](mailto:hello@callstack.com) if you need any help with these or just want to say hi!
  76. Like the project? ⚛️ [Join the team](https://callstack.com/careers/?utm_campaign=Senior_RN&utm_source=github&utm_medium=readme) who does amazing stuff for clients and drives React Native Open Source! 🔥
  77. ---
  78. Supported and used by [Rally Health](https://www.rallyhealth.com/careers).
  79. <!-- badges -->
  80. [version-badge]: https://img.shields.io/npm/v/@testing-library/react-native.svg?style=flat-square
  81. [package]: https://www.npmjs.com/package/@testing-library/react-native
  82. [build-badge]: https://github.com/callstack/react-native-testing-library/actions/workflows/ci.yml/badge.svg
  83. [build]: https://github.com/callstack/react-native-testing-library/actions/workflows/ci.yml
  84. [coverage-badge]: https://img.shields.io/codecov/c/github/callstack/react-native-testing-library.svg
  85. [coverage]: https://codecov.io/github/callstack/react-native-testing-library
  86. [downloads-badge]: https://img.shields.io/npm/dm/@testing-library/react-native.svg?style=flat-square
  87. [downloads]: http://www.npmtrends.com/@testing-library/react-native
  88. [license-badge]: https://img.shields.io/npm/l/@testing-library/react-native.svg
  89. [license]: https://opensource.org/licenses/MIT
  90. [callstack-badge]: https://callstack.com/images/callstack-badge.svg
  91. [callstack]: https://callstack.com/open-source/?utm_source=github.com&utm_medium=referral&utm_campaign=react-native-testing-library&utm_term=readme

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.