Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
@testing-library/react-native
Advanced tools
Readme
Simple and complete React Native testing utilities that encourage good testing practices.
You want to write maintainable tests for your React Native 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 tests 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.
The React Native Testing Library (RNTL) is a lightweight solution for testing React Native components. It provides light utility functions on top of react-test-renderer
, in a way that encourages better testing practices. Its primary guiding principle is:
The more your tests resemble the way your software is used, the more confidence they can give you.
This project is inspired by React Testing Library. Tested to work with Jest, but it should work with other test runners as well.
Open a Terminal in your project's folder and run:
yarn
yarn add --dev @testing-library/react-native
npm
npm install --save-dev @testing-library/react-native
This library has a peerDependencies
listing for react-test-renderer
. Make sure that your react-test-renderer
version matches exactly the react
version.
You can use the built-in Jest matchers by adding the following line to your jest-setup.ts
file (configured using setupFilesAfterEnv
):
import '@testing-library/react-native/extend-expect';
We generally advise using the "react-native" preset when testing with this library.
However, if you use React Native version earlier than 0.71 with modern Jest fake timers (default since Jest 27), you'll need to apply this custom Jest preset or otherwise awaiting promises, like using waitFor
or findBy*
, queries will fail with a timeout.
This is a known issue. It happens because React Native's Jest preset overrides native Promise. Our preset restores it to defaults, which is not a problem in most apps out there.
Here's how you apply a custom preset in your Jest config:
{
"preset": "@testing-library/react-native"
}
If this doesn't work for you, please fall back to using "legacy" fake timers.
Note for Flow users – you'll also need to install typings for react-test-renderer
:
flow-typed install react-test-renderer
import { render, screen, fireEvent } from '@testing-library/react-native';
import { QuestionsBoard } from '../QuestionsBoard';
// It is recommended to use userEvent with fake timers
// Some events involve duration so your tests may take a long time to run.
jest.useFakeTimers();
test('form submits two answers', async () => {
const questions = ['q1', 'q2'];
const onSubmit = jest.fn();
const user = userEvent.setup();
render(<QuestionsBoard questions={questions} onSubmit={onSubmit} />);
const answerInputs = screen.getAllByLabelText('answer input');
// simulates the user focusing on TextInput and typing text one char at a time
await user.type(answerInputs[0], 'a1');
await user.type(answerInputs[1], 'a2');
// simulates the user pressing on any pressable element
await user.press(screen.getByRole('button', { name: 'Submit' }));
expect(onSubmit).toHaveBeenCalledWith({
1: { q: 'q1', a: 'a1' },
2: { q: 'q2', a: 'a2' },
});
});
You can find the source of QuestionsBoard
component and this example here.
The public API of @testing-library/react-native
is focused around these essential APIs:
render
– renders the given React elementscreen
– queries for looking up rendered elements, as well as some useful helpers.userEvent
- realistic simulation of user interaction with elements like buttons and text inputs.fireEvent
- general purpose event simulation.waitFor
- waits for non-deterministic periods of time until the queried element is added or times out.waitForElementToBeRemoved
- waits for non-deterministic periods of time until the queried element is removed or times out.within
- creates a queries object scoped for a given element.Check out our list of Community Resources about RNTL.
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!
Like the project? ⚛️ Join the team who does amazing stuff for clients and drives React Native Open Source! 🔥
Supported and used by Rally Health.
FAQs
Simple and complete React Native testing utilities that encourage good testing practices.
The npm package @testing-library/react-native receives a total of 523,992 weekly downloads. As such, @testing-library/react-native popularity was classified as popular.
We found that @testing-library/react-native demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 15 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.