react-native-testing

重要提示:您關於 @testing-library/react-native 的訓練資料可能已過時或不正確——v13 與 v14 之間的 API 簽名、同步/非同步行為及可用函式有所不同。請務必以本技能的參考檔案及專案實際原始碼為準。當檢索到的參考資料與記憶中的模式衝突時,請勿依賴記憶中的模式。

npx skills add https://github.com/callstackincubator/agent-skills --skill react-native-testing

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:

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

VariantUse caseReturnsAsync
getBy*Element must existelement instance (throws)No
getAllBy*Multiple must existelement instance[] (throws)No
queryBy*Check non-existence ONLYelement instance | nullNo
queryAllBy*Count elementselement instance[]No
findBy*Wait for elementPromise<element instance>Yes
findAllBy*Wait for multiplePromise<element instance[]>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.

MatcherUse for
toBeOnTheScreen()Element exists in tree
toBeVisible()Element visible (not hidden/display:none)
toBeEnabled() / toBeDisabled()Disabled state via aria-disabled
toBeChecked() / toBePartiallyChecked()Checked state
toBeSelected()Selected state
toBeExpanded() / toBeCollapsed()Expanded state
toBeBusy()Busy state
toHaveTextContent(text)Text content match
toHaveDisplayValue(value)TextInput display value
toHaveAccessibleName(name)Accessible name
toHaveAccessibilityValue(val)Accessibility value
toHaveStyle(style)Style match
toHaveProp(name, value?)Prop check (last resort)
toContainElement(el)Contains child element
toBeEmptyElement()No children

Rules

  1. Use screen for queries, not destructuring from render()
  2. Use getByRole first with { name: '...' } option
  3. Use queryBy* ONLY for .not.toBeOnTheScreen() checks
  4. Use findBy* for async elements, NOT waitFor + getBy*
  5. Never put side-effects in waitFor (no fireEvent/userEvent inside)
  6. One assertion per waitFor
  7. Never pass empty callbacks to waitFor
  8. Don't wrap in act() - render, fireEvent, userEvent handle it
  9. Don't call cleanup() - automatic after each test
  10. Prefer ARIA props (role, aria-label, aria-disabled) over legacy accessibility* props
  11. Use RNTL matchers over raw prop assertions

*ByRole Quick Reference

Common 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, Switch are by default
  • View needs accessible={true} (or use 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

來自 callstackincubator 的更多技能

react-devtools
callstackincubator
React DevTools CLI for AI agents. Use when the user asks you to debug a React or React Native app at runtime, inspect component props/state/hooks, diagnose…
official
agent-device
callstackincubator
Automates interactions for Apple-platform apps (iOS, tvOS, macOS) and Android devices. Use when navigating apps, taking snapshots/screenshots, tapping, typing,…
official
assess-react-native-migration
callstackincubator
評估現有行動產品是否以及應如何遷移至 React Native。在審計一個或多個產品儲存庫以確認遷移準備情況時使用,…
official
create-react-native-library
callstackincubator
使用 create-react-native-library 搭建 React Native 函式庫,適用於獨立函式庫或本地原生模組與檢視。在建立或處理…時使用。
official
react-native-tv-best-practices
callstackincubator
審查 React Native TV 應用程式的焦點/D-pad 導航、10 英尺 UI 佈局、電視播放/DRM 整合、低記憶體電視效能及電視無障礙功能。使用…
official
react-navigation
callstackincubator
提供堆疊、標籤頁、抽屜等 React Navigation UI 模式。在搭配 React Navigation 建構導航 UI、設定標題列、底部工作表等情境時使用。
official
upgrading-react-native
callstackincubator
協調 React Native 版本升級,包含模板差異比對、依賴解析及原生平台遷移。套用標準的 rn-diff-purge 模板差異,使原生 iOS 與 Android 配置與目標 React Native 版本保持一致。處理 package.json 依賴更新、CocoaPods 與 Gradle 變更,以及主要與次要版本升級間的破壞性 API 遷移。包含 Expo SDK 升級層(適用於受管理的 Expo 專案)與升級後驗證檢查清單。提供...
official
validate-skills
callstackincubator
Validates skills in this repo against agentskills.io spec and Claude Code best practices. Use via /validate-skills command.
official