Skip to content

CHANGELOG.md

Latest commit

 

History

History
92 lines (75 loc) · 4.33 KB

CHANGELOG.md

File metadata and controls

92 lines (75 loc) · 4.33 KB

Changelog

All notable changes to React Native Testing Library will be documented in this file, starting with v14.

14.0.0

Migration guide

See the Migration to 14.x guide for step-by-step upgrade instructions, codemods, and before/after examples.

Breaking changes

  • Dropped support for React 18. React 19.0.0 or newer is now required.
  • Raised the minimum supported React Native version to 0.78.
  • Raised the minimum supported Node.js version to ^22.13.0 || >=24.
  • Replaced the deprecated React Test Renderer with Test Renderer.
  • Added a peer dependency on Test Renderer 1.x. Install the Test Renderer compatibility line that matches your React 19 minor version.
  • Made the core rendering and event APIs async by default:
    • render() now returns Promise<RenderResult>.
    • renderHook() now returns Promise<RenderHookResult>.
    • fireEvent() and its helpers now return Promise<void>.
    • act() now always returns a Promise and should always be awaited.
  • Removed the renderAsync, renderHookAsync, and fireEventAsync APIs. Use render, renderHook, and fireEvent instead.
  • Removed the update alias. Use rerender instead.
  • Removed the getQueriesForElement alias. Use within instead.
  • Removed UNSAFE_root. Use container for the pseudo-element container or root for the first rendered host element.
  • Removed legacy UNSAFE_* queries:
    • UNSAFE_getAllByType
    • UNSAFE_getByType
    • UNSAFE_getAllByProps
    • UNSAFE_getByProps
  • Removed the concurrentRoot render and configuration option. Concurrent rendering is always enabled in v14.
  • Removed the createNodeMock render option, which is not supported by the new Test Renderer integration.
  • Removed the unstable_validateStringsRenderedWithinText render option. Text string validation is now always enabled.

Notable changes

  • Reintroduced the container API as a safe pseudo-element container, aligned with React Testing Library semantics.
  • Query results and the rendered element tree now expose host elements only. Composite components are no longer visible through the test tree.
  • Type definitions now use TestInstance from Test Renderer instead of ReactTestInstance from React Test Renderer.
  • Suspended or hidden instances are now represented with React Native-like hidden props, such as display: 'none', so visibility queries and matchers behave closer to runtime behavior.
  • fireEvent.press() and fireEvent.scroll() now pass default synthetic native event objects to handlers and deep-merge any event props supplied by the test.
  • Accessible name calculation now follows React Native inputs more closely, including TextInput placeholder handling, child accessible name concatenation, and stricter getByRole(..., { name }) matching.
  • configure, render, renderHook, and userEvent.setup now warn when unknown options are passed, helping catch stale or misspelled options during migration.
  • Text strings rendered outside of React Native <Text> components now throw, matching React Native runtime behavior.

Test Renderer versions

Install the Test Renderer version that matches your React 19 minor version:

React version Recommended Test Renderer version
19.2 test-renderer@1.2
19.1 test-renderer@1.1
19.0 test-renderer@1.0

Older Test Renderer lines may not support newer React 19 features in tests. Newer Test Renderer lines can produce peer dependency warnings, or an install error with npm. See the Test Renderer React 19 compatibility lines for the latest recommendations.

Codemods

Two codemods are available to automate the most common v14 upgrade work:

  • rntl-v14-update-deps updates dependencies by removing React Test Renderer packages, adding Test Renderer, and updating React Native Testing Library.
  • rntl-v14-async-functions updates test code for async render, renderHook, fireEvent, act, rerender, and unmount usage.

Full changelog

See the full GitHub comparison: https://github.com/callstack/react-native-testing-library/compare/v13.3.3...v14.0.0