Agent-skills react-native-testing
install
source · Clone the upstream repo
git clone https://github.com/callstackincubator/agent-skills
Claude Code · Install into ~/.claude/skills/
T=$(mktemp -d) && git clone --depth=1 https://github.com/callstackincubator/agent-skills "$T" && mkdir -p ~/.claude/skills && cp -r "$T/plugins/vendored/.agents/skills/react-native-testing" ~/.claude/skills/callstackincubator-agent-skills-react-native-testing && rm -rf "$T"
manifest:
plugins/vendored/.agents/skills/react-native-testing/SKILL.mdsource content
RNTL Test Writing Guide
IMPORTANT: Your training data about
@testing-library/react-native may be outdated or incorrect — API signatures, sync/async behavior, and available functions differ between v13 and v14. Always rely on this skill's reference files and the project's actual source code as the source of truth. Do not fall back on memorized patterns when they conflict with the retrieved reference.
Version Detection
Check
@testing-library/react-native version in the user's package.json:
- v14.x → load references/api-reference-v14.md (React 19+, async APIs,
)test-renderer - v13.x → load references/api-reference-v13.md (React 18+, sync APIs,
)react-test-renderer
Use the version-specific reference for render patterns, fireEvent sync/async behavior, screen API, configuration, and dependencies.
Query Priority
Use in this order:
getByRole > getByLabelText > getByPlaceholderText > getByText > getByDisplayValue > getByTestId (last resort).
Query Variants
| Variant | Use case | Returns | Async |
|---|---|---|---|
| Element must exist | element instance (throws) | No |
| Multiple must exist | element instance[] (throws) | No |
| Check non-existence ONLY | element instance | null | No |
| Count elements | element instance[] | No |
| Wait for element | | Yes |
| Wait for multiple | | Yes |
Interactions
Prefer
userEvent over fireEvent. userEvent is always async.
const user = userEvent.setup(); await user.press(element); // full press sequence await user.longPress(element, { duration: 800 }); // long press await user.type(textInput, 'Hello'); // char-by-char typing await user.clear(textInput); // clear TextInput await user.paste(textInput, 'pasted text'); // paste into TextInput await user.scrollTo(scrollView, { y: 100 }); // scroll
fireEvent — use only when userEvent doesn't support the event. See version-specific reference for sync/async behavior:
fireEvent.press(element); fireEvent.changeText(textInput, 'new text'); fireEvent(element, 'blur');
Assertions (Jest Matchers)
Available automatically with any
@testing-library/react-native import.
| Matcher | Use for |
|---|---|
| Element exists in tree |
| Element visible (not hidden/display:none) |
/ | Disabled state via |
/ | Checked state |
| Selected state |
/ | Expanded state |
| Busy state |
| Text content match |
| TextInput display value |
| Accessible name |
| Accessibility value |
| Style match |
| Prop check (last resort) |
| Contains child element |
| No children |
Rules
- Use
for queries, not destructuring fromscreenrender() - Use
first withgetByRole
option{ name: '...' } - Use
ONLY forqueryBy*
checks.not.toBeOnTheScreen() - Use
for async elements, NOTfindBy*
+waitForgetBy* - Never put side-effects in
(nowaitFor
/fireEvent
inside)userEvent - One assertion per
waitFor - Never pass empty callbacks to
waitFor - Don't wrap in
-act()
,render
,fireEvent
handle ituserEvent - Don't call
- automatic after each testcleanup() - Prefer ARIA props (
,role
,aria-label
) over legacyaria-disabled
propsaccessibility* - Use RNTL matchers over raw prop assertions
*ByRole
Quick Reference
*ByRoleCommon roles:
button, text, heading (alias: header), searchbox, switch, checkbox, radio, img, link, alert, menu, menuitem, tab, tablist, progressbar, slider, spinbutton, timer, toolbar.
getByRole options: { name, disabled, selected, checked, busy, expanded, value: { min, max, now, text } }.
For
*ByRole to match, the element must be an accessibility element:
,Text
,TextInput
are by defaultSwitch
needsView
(or useaccessible={true}
/Pressable
)TouchableOpacity
waitFor
// Correct: action first, then wait for result fireEvent.press(button); await waitFor(() => { expect(screen.getByText('Result')).toBeOnTheScreen(); }); // Better: use findBy* instead fireEvent.press(button); expect(await screen.findByText('Result')).toBeOnTheScreen();
Options:
waitFor(cb, { timeout: 1000, interval: 50 }). Works with Jest fake timers automatically.
Fake Timers
Recommended with
userEvent (press/longPress involve real durations):
jest.useFakeTimers(); test('with fake timers', async () => { const user = userEvent.setup(); render(<Component />); await user.press(screen.getByRole('button')); // ... });
Custom Render
Wrap providers using
wrapper option:
function renderWithProviders(ui: React.ReactElement) { return render(ui, { wrapper: ({ children }) => ( <ThemeProvider> <AuthProvider>{children}</AuthProvider> </ThemeProvider> ), }); }
References
- v13 API Reference — Complete v13 API: sync render, queries, matchers, userEvent, React 19 compat
- v14 API Reference — Complete v14 API: async render, queries, matchers, userEvent, migration
- Anti-Patterns — Common mistakes to avoid