@testing-library/react-native 14.0.0-rc.0 → 14.0.0-rc.2

package/README.md

@@ -12,11 +12,6 @@
 [![MIT License][license-badge]][license]
 [![Sponsored by Callstack][callstack-badge]][callstack]
 
-> [!WARNING]
-> **Beta Version:** This version (v14) is currently in beta. APIs and behavior may change before the stable release. Please report any issues you encounter.
->
-> For stable version (v13) see [README-v13.md](./README-v13.md).
-
 ## The problem
 
 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.
@@ -34,7 +29,7 @@ This project is inspired by [React Testing Library](https://github.com/testing-l
 Open a Terminal in your project's folder and run:
 
 ```sh
-npm install --save-dev @testing-library/react-native@alpha
+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:

package/{build → dist}/helpers/accessibility.js

@@ -140,14 +140,17 @@ function computeAriaModal(instance) {
   return instance.props['aria-modal'] ?? instance.props.accessibilityViewIsModal;
 }
 function computeAriaLabel(instance) {
-  const labelElementId = instance.props['aria-labelledby'] ?? instance.props.accessibilityLabelledBy;
-  if (labelElementId) {
+  const labelElementIds = getAriaLabelledByIds(instance);
+  if (labelElementIds.length > 0) {
     const container = (0, _componentTree.getContainerInstance)(instance);
-    const labelInstance = (0, _findAll.findAll)(container, node => (0, _componentTree.isTestInstance)(node) && node.props.nativeID === labelElementId, {
-      includeHiddenElements: true
-    });
-    if (labelInstance.length > 0) {
-      return (0, _textContent.getTextContent)(labelInstance[0]);
+    const labelTexts = labelElementIds.map(labelElementId => {
+      const labelInstance = (0, _findAll.findAll)(container, node => (0, _componentTree.isTestInstance)(node) && node.props.nativeID === labelElementId, {
+        includeHiddenElements: true
+      });
+      return labelInstance.length > 0 ? (0, _textContent.getTextContent)(labelInstance[0]) : undefined;
+    }).filter(labelText => labelText !== undefined);
+    if (labelTexts.length > 0) {
+      return labelTexts.join(' ').trim().replace(/\s+/g, ' ');
     }
   }
   const explicitLabel = instance.props['aria-label'] ?? instance.props.accessibilityLabel;
@@ -161,6 +164,20 @@ function computeAriaLabel(instance) {
   }
   return undefined;
 }
+function getAriaLabelledByIds(instance) {
+  const ariaLabelledBy = instance.props['aria-labelledby'];
+  if (typeof ariaLabelledBy === 'string') {
+    return [ariaLabelledBy];
+  }
+  const accessibilityLabelledBy = instance.props.accessibilityLabelledBy;
+  if (Array.isArray(accessibilityLabelledBy)) {
+    return accessibilityLabelledBy;
+  }
+  if (typeof accessibilityLabelledBy === 'string') {
+    return [accessibilityLabelledBy];
+  }
+  return [];
+}
 
 // See: https://github.com/callstack/react-native-testing-library/wiki/Accessibility:-State#busy-state
 function computeAriaBusy({

package/dist/helpers/accessibility.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accessibility.js","names":["_reactNative","require","_componentTree","_findAll","_hostComponentNames","_textContent","_textInput","accessibilityStateKeys","exports","accessibilityValueKeys","isHiddenFromAccessibility","instance","cache","current","isCurrentSubtreeInaccessible","get","undefined","isSubtreeInaccessible","set","parent","isInaccessible","props","accessibilityElementsHidden","importantForAccessibility","flatStyle","StyleSheet","flatten","style","display","hostSiblings","getInstanceSiblings","some","sibling","computeAriaModal","isAccessibilityElement","isHostImage","alt","accessible","isHostText","isHostTextInput","isHostSwitch","getRole","explicitRole","role","accessibilityRole","normalizeRole","accessibilityViewIsModal","computeAriaLabel","labelElementIds","getAriaLabelledByIds","length","container","getContainerInstance","labelTexts","map","labelElementId","labelInstance","findAll","node","isTestInstance","nativeID","includeHiddenElements","getTextContent","filter","labelText","join","trim","replace","explicitLabel","accessibilityLabel","ariaLabelledBy","accessibilityLabelledBy","Array","isArray","computeAriaBusy","accessibilityState","busy","computeAriaChecked","value","rolesSupportingCheckedState","checked","computeAriaDisabled","isEditableTextInput","disabled","computeAriaExpanded","expanded","computeAriaSelected","selected","computeAriaValue","accessibilityValue","ariaValueMax","ariaValueMin","ariaValueNow","ariaValueText","max","min","now","text","computeAccessibleName","options","label","placeholder","root","parts","child","children","push","childLabel","checkbox","radio","switch"],"sources":["../../src/helpers/accessibility.ts"],"sourcesContent":["import type { AccessibilityRole, AccessibilityState, AccessibilityValue, Role } from 'react-native';\nimport { StyleSheet } from 'react-native';\nimport type { TestInstance } from 'test-renderer';\n\nimport { getContainerInstance, getInstanceSiblings, isTestInstance } from './component-tree';\nimport { findAll } from './find-all';\nimport { isHostImage, isHostSwitch, isHostText, isHostTextInput } from './host-component-names';\nimport { getTextContent } from './text-content';\nimport { isEditableTextInput } from './text-input';\n\ntype IsInaccessibleOptions = {\n  cache?: WeakMap<TestInstance, boolean>;\n};\n\nexport const accessibilityStateKeys: (keyof AccessibilityState)[] = [\n  'disabled',\n  'selected',\n  'checked',\n  'busy',\n  'expanded',\n];\n\nexport const accessibilityValueKeys: (keyof AccessibilityValue)[] = ['min', 'max', 'now', 'text'];\n\nexport function isHiddenFromAccessibility(\n  instance: TestInstance | null,\n  { cache }: IsInaccessibleOptions = {},\n): boolean {\n  if (instance == null) {\n    return true;\n  }\n\n  let current: TestInstance | null = instance;\n  while (current) {\n    let isCurrentSubtreeInaccessible = cache?.get(current);\n\n    if (isCurrentSubtreeInaccessible === undefined) {\n      isCurrentSubtreeInaccessible = isSubtreeInaccessible(current);\n      cache?.set(current, isCurrentSubtreeInaccessible);\n    }\n\n    if (isCurrentSubtreeInaccessible) {\n      return true;\n    }\n\n    current = current.parent;\n  }\n\n  return false;\n}\n\n/** RTL-compatibility alias for `isHiddenFromAccessibility` */\nexport const isInaccessible = isHiddenFromAccessibility;\n\nfunction isSubtreeInaccessible(instance: TestInstance): boolean {\n  // See: https://reactnative.dev/docs/accessibility#aria-hidden\n  if (instance.props['aria-hidden']) {\n    return true;\n  }\n\n  // iOS: accessibilityElementsHidden\n  // See: https://reactnative.dev/docs/accessibility#accessibilityelementshidden-ios\n  if (instance.props.accessibilityElementsHidden) {\n    return true;\n  }\n\n  // Android: importantForAccessibility\n  // See: https://reactnative.dev/docs/accessibility#importantforaccessibility-android\n  if (instance.props.importantForAccessibility === 'no-hide-descendants') {\n    return true;\n  }\n\n  // Note that `opacity: 0` is not treated as inaccessible on iOS\n  const flatStyle = StyleSheet.flatten(instance.props.style) ?? {};\n  if (flatStyle.display === 'none') return true;\n\n  // iOS: accessibilityViewIsModal or aria-modal\n  // See: https://reactnative.dev/docs/accessibility#accessibilityviewismodal-ios\n  const hostSiblings = getInstanceSiblings(instance);\n  if (hostSiblings.some((sibling) => computeAriaModal(sibling))) {\n    return true;\n  }\n\n  return false;\n}\n\nexport function isAccessibilityElement(instance: TestInstance | null): boolean {\n  if (instance == null) {\n    return false;\n  }\n\n  // https://github.com/facebook/react-native/blob/8dabed60f456e76a9e53273b601446f34de41fb5/packages/react-native/Libraries/Image/Image.ios.js#L172\n  if (isHostImage(instance) && instance.props.alt !== undefined) {\n    return true;\n  }\n\n  if (instance.props.accessible !== undefined) {\n    return instance.props.accessible;\n  }\n\n  return isHostText(instance) || isHostTextInput(instance) || isHostSwitch(instance);\n}\n\n/**\n * Returns the accessibility role for given element. It will return explicit\n * role from either `role` or `accessibilityRole` props if set.\n *\n * If explicit role is not available, it would try to return default element\n * role:\n * - `text` for `Text` elements\n *\n * In all other cases this functions returns `none`.\n *\n * @param instance\n * @returns\n */\nexport function getRole(instance: TestInstance): Role | AccessibilityRole {\n  const explicitRole = instance.props.role ?? instance.props.accessibilityRole;\n  if (explicitRole) {\n    return normalizeRole(explicitRole);\n  }\n\n  if (isHostText(instance)) {\n    return 'text';\n  }\n\n  // Note: host Image elements report \"image\" role in screen reader only on Android, but not on iOS.\n  // It's better to require explicit role for Image elements.\n\n  return 'none';\n}\n\n/**\n * There are some duplications between (ARIA) `Role` and `AccessibilityRole` types.\n * Resolve them by using ARIA `Role` type where possible.\n *\n * @param role Role to normalize\n * @returns Normalized role\n */\nexport function normalizeRole(role: string): Role | AccessibilityRole {\n  if (role === 'image') {\n    return 'img';\n  }\n\n  return role as Role | AccessibilityRole;\n}\n\nexport function computeAriaModal(instance: TestInstance): boolean | undefined {\n  return instance.props['aria-modal'] ?? instance.props.accessibilityViewIsModal;\n}\n\nexport function computeAriaLabel(instance: TestInstance): string | undefined {\n  const labelElementIds = getAriaLabelledByIds(instance);\n  if (labelElementIds.length > 0) {\n    const container = getContainerInstance(instance);\n    const labelTexts = labelElementIds\n      .map((labelElementId) => {\n        const labelInstance = findAll(\n          container,\n          (node) => isTestInstance(node) && node.props.nativeID === labelElementId,\n          { includeHiddenElements: true },\n        );\n\n        return labelInstance.length > 0 ? getTextContent(labelInstance[0]) : undefined;\n      })\n      .filter((labelText): labelText is string => labelText !== undefined);\n\n    if (labelTexts.length > 0) {\n      return labelTexts.join(' ').trim().replace(/\\s+/g, ' ');\n    }\n  }\n\n  const explicitLabel = instance.props['aria-label'] ?? instance.props.accessibilityLabel;\n  if (explicitLabel) {\n    return explicitLabel;\n  }\n\n  //https://github.com/facebook/react-native/blob/8dabed60f456e76a9e53273b601446f34de41fb5/packages/react-native/Libraries/Image/Image.ios.js#L173\n  if (isHostImage(instance) && instance.props.alt) {\n    return instance.props.alt;\n  }\n\n  return undefined;\n}\n\nfunction getAriaLabelledByIds(instance: TestInstance): string[] {\n  const ariaLabelledBy = instance.props['aria-labelledby'];\n  if (typeof ariaLabelledBy === 'string') {\n    return [ariaLabelledBy];\n  }\n\n  const accessibilityLabelledBy = instance.props.accessibilityLabelledBy;\n  if (Array.isArray(accessibilityLabelledBy)) {\n    return accessibilityLabelledBy;\n  }\n\n  if (typeof accessibilityLabelledBy === 'string') {\n    return [accessibilityLabelledBy];\n  }\n\n  return [];\n}\n\n// See: https://github.com/callstack/react-native-testing-library/wiki/Accessibility:-State#busy-state\nexport function computeAriaBusy({ props }: TestInstance): boolean {\n  return props['aria-busy'] ?? props.accessibilityState?.busy ?? false;\n}\n\n// See: https://github.com/callstack/react-native-testing-library/wiki/Accessibility:-State#checked-state\nexport function computeAriaChecked(instance: TestInstance): AccessibilityState['checked'] {\n  const { props } = instance;\n\n  if (isHostSwitch(instance)) {\n    return props.value;\n  }\n\n  const role = getRole(instance);\n  if (!rolesSupportingCheckedState[role]) {\n    return undefined;\n  }\n\n  return props['aria-checked'] ?? props.accessibilityState?.checked;\n}\n\n// See: https://github.com/callstack/react-native-testing-library/wiki/Accessibility:-State#disabled-state\nexport function computeAriaDisabled(instance: TestInstance): boolean {\n  if (isHostTextInput(instance) && !isEditableTextInput(instance)) {\n    return true;\n  }\n\n  const { props } = instance;\n\n  if (isHostText(instance) && props.disabled) {\n    return true;\n  }\n\n  return props['aria-disabled'] ?? props.accessibilityState?.disabled ?? false;\n}\n\n// See: https://github.com/callstack/react-native-testing-library/wiki/Accessibility:-State#expanded-state\nexport function computeAriaExpanded({ props }: TestInstance): boolean | undefined {\n  return props['aria-expanded'] ?? props.accessibilityState?.expanded;\n}\n\n// See: https://github.com/callstack/react-native-testing-library/wiki/Accessibility:-State#selected-state\nexport function computeAriaSelected({ props }: TestInstance): boolean {\n  return props['aria-selected'] ?? props.accessibilityState?.selected ?? false;\n}\n\nexport function computeAriaValue(instance: TestInstance): AccessibilityValue {\n  const {\n    accessibilityValue,\n    'aria-valuemax': ariaValueMax,\n    'aria-valuemin': ariaValueMin,\n    'aria-valuenow': ariaValueNow,\n    'aria-valuetext': ariaValueText,\n  } = instance.props;\n\n  return {\n    max: ariaValueMax ?? accessibilityValue?.max,\n    min: ariaValueMin ?? accessibilityValue?.min,\n    now: ariaValueNow ?? accessibilityValue?.now,\n    text: ariaValueText ?? accessibilityValue?.text,\n  };\n}\n\ntype ComputeAccessibleNameOptions = {\n  root?: boolean;\n};\n\nexport function computeAccessibleName(\n  instance: TestInstance,\n  options?: ComputeAccessibleNameOptions,\n): string | undefined {\n  const label = computeAriaLabel(instance);\n  if (label) {\n    return label;\n  }\n\n  if (isHostTextInput(instance) && instance.props.placeholder && options?.root !== false) {\n    return instance.props.placeholder;\n  }\n\n  const parts = [];\n  for (const child of instance.children) {\n    if (typeof child === 'string') {\n      if (child) {\n        parts.push(child);\n      }\n    } else {\n      const childLabel = computeAccessibleName(child, { root: false });\n      if (childLabel) {\n        parts.push(childLabel);\n      }\n    }\n  }\n\n  return parts.join(' ');\n}\n\ntype RoleSupportMap = Partial<Record<Role | AccessibilityRole, true>>;\n\nexport const rolesSupportingCheckedState: RoleSupportMap = {\n  checkbox: true,\n  radio: true,\n  switch: true,\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AACA,IAAAA,YAAA,GAAAC,OAAA;AAGA,IAAAC,cAAA,GAAAD,OAAA;AACA,IAAAE,QAAA,GAAAF,OAAA;AACA,IAAAG,mBAAA,GAAAH,OAAA;AACA,IAAAI,YAAA,GAAAJ,OAAA;AACA,IAAAK,UAAA,GAAAL,OAAA;AAMO,MAAMM,sBAAoD,GAAAC,OAAA,CAAAD,sBAAA,GAAG,CAClE,UAAU,EACV,UAAU,EACV,SAAS,EACT,MAAM,EACN,UAAU,CACX;AAEM,MAAME,sBAAoD,GAAAD,OAAA,CAAAC,sBAAA,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC;AAE1F,SAASC,yBAAyBA,CACvCC,QAA6B,EAC7B;EAAEC;AAA6B,CAAC,GAAG,CAAC,CAAC,EAC5B;EACT,IAAID,QAAQ,IAAI,IAAI,EAAE;IACpB,OAAO,IAAI;EACb;EAEA,IAAIE,OAA4B,GAAGF,QAAQ;EAC3C,OAAOE,OAAO,EAAE;IACd,IAAIC,4BAA4B,GAAGF,KAAK,EAAEG,GAAG,CAACF,OAAO,CAAC;IAEtD,IAAIC,4BAA4B,KAAKE,SAAS,EAAE;MAC9CF,4BAA4B,GAAGG,qBAAqB,CAACJ,OAAO,CAAC;MAC7DD,KAAK,EAAEM,GAAG,CAACL,OAAO,EAAEC,4BAA4B,CAAC;IACnD;IAEA,IAAIA,4BAA4B,EAAE;MAChC,OAAO,IAAI;IACb;IAEAD,OAAO,GAAGA,OAAO,CAACM,MAAM;EAC1B;EAEA,OAAO,KAAK;AACd;;AAEA;AACO,MAAMC,cAAc,GAAAZ,OAAA,CAAAY,cAAA,GAAGV,yBAAyB;AAEvD,SAASO,qBAAqBA,CAACN,QAAsB,EAAW;EAC9D;EACA,IAAIA,QAAQ,CAACU,KAAK,CAAC,aAAa,CAAC,EAAE;IACjC,OAAO,IAAI;EACb;;EAEA;EACA;EACA,IAAIV,QAAQ,CAACU,KAAK,CAACC,2BAA2B,EAAE;IAC9C,OAAO,IAAI;EACb;;EAEA;EACA;EACA,IAAIX,QAAQ,CAACU,KAAK,CAACE,yBAAyB,KAAK,qBAAqB,EAAE;IACtE,OAAO,IAAI;EACb;;EAEA;EACA,MAAMC,SAAS,GAAGC,uBAAU,CAACC,OAAO,CAACf,QAAQ,CAACU,KAAK,CAACM,KAAK,CAAC,IAAI,CAAC,CAAC;EAChE,IAAIH,SAAS,CAACI,OAAO,KAAK,MAAM,EAAE,OAAO,IAAI;;EAE7C;EACA;EACA,MAAMC,YAAY,GAAG,IAAAC,kCAAmB,EAACnB,QAAQ,CAAC;EAClD,IAAIkB,YAAY,CAACE,IAAI,CAAEC,OAAO,IAAKC,gBAAgB,CAACD,OAAO,CAAC,CAAC,EAAE;IAC7D,OAAO,IAAI;EACb;EAEA,OAAO,KAAK;AACd;AAEO,SAASE,sBAAsBA,CAACvB,QAA6B,EAAW;EAC7E,IAAIA,QAAQ,IAAI,IAAI,EAAE;IACpB,OAAO,KAAK;EACd;;EAEA;EACA,IAAI,IAAAwB,+BAAW,EAACxB,QAAQ,CAAC,IAAIA,QAAQ,CAACU,KAAK,CAACe,GAAG,KAAKpB,SAAS,EAAE;IAC7D,OAAO,IAAI;EACb;EAEA,IAAIL,QAAQ,CAACU,KAAK,CAACgB,UAAU,KAAKrB,SAAS,EAAE;IAC3C,OAAOL,QAAQ,CAACU,KAAK,CAACgB,UAAU;EAClC;EAEA,OAAO,IAAAC,8BAAU,EAAC3B,QAAQ,CAAC,IAAI,IAAA4B,mCAAe,EAAC5B,QAAQ,CAAC,IAAI,IAAA6B,gCAAY,EAAC7B,QAAQ,CAAC;AACpF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAAS8B,OAAOA,CAAC9B,QAAsB,EAA4B;EACxE,MAAM+B,YAAY,GAAG/B,QAAQ,CAACU,KAAK,CAACsB,IAAI,IAAIhC,QAAQ,CAACU,KAAK,CAACuB,iBAAiB;EAC5E,IAAIF,YAAY,EAAE;IAChB,OAAOG,aAAa,CAACH,YAAY,CAAC;EACpC;EAEA,IAAI,IAAAJ,8BAAU,EAAC3B,QAAQ,CAAC,EAAE;IACxB,OAAO,MAAM;EACf;;EAEA;EACA;;EAEA,OAAO,MAAM;AACf;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASkC,aAAaA,CAACF,IAAY,EAA4B;EACpE,IAAIA,IAAI,KAAK,OAAO,EAAE;IACpB,OAAO,KAAK;EACd;EAEA,OAAOA,IAAI;AACb;AAEO,SAASV,gBAAgBA,CAACtB,QAAsB,EAAuB;EAC5E,OAAOA,QAAQ,CAACU,KAAK,CAAC,YAAY,CAAC,IAAIV,QAAQ,CAACU,KAAK,CAACyB,wBAAwB;AAChF;AAEO,SAASC,gBAAgBA,CAACpC,QAAsB,EAAsB;EAC3E,MAAMqC,eAAe,GAAGC,oBAAoB,CAACtC,QAAQ,CAAC;EACtD,IAAIqC,eAAe,CAACE,MAAM,GAAG,CAAC,EAAE;IAC9B,MAAMC,SAAS,GAAG,IAAAC,mCAAoB,EAACzC,QAAQ,CAAC;IAChD,MAAM0C,UAAU,GAAGL,eAAe,CAC/BM,GAAG,CAAEC,cAAc,IAAK;MACvB,MAAMC,aAAa,GAAG,IAAAC,gBAAO,EAC3BN,SAAS,EACRO,IAAI,IAAK,IAAAC,6BAAc,EAACD,IAAI,CAAC,IAAIA,IAAI,CAACrC,KAAK,CAACuC,QAAQ,KAAKL,cAAc,EACxE;QAAEM,qBAAqB,EAAE;MAAK,CAChC,CAAC;MAED,OAAOL,aAAa,CAACN,MAAM,GAAG,CAAC,GAAG,IAAAY,2BAAc,EAACN,aAAa,CAAC,CAAC,CAAC,CAAC,GAAGxC,SAAS;IAChF,CAAC,CAAC,CACD+C,MAAM,CAAEC,SAAS,IAA0BA,SAAS,KAAKhD,SAAS,CAAC;IAEtE,IAAIqC,UAAU,CAACH,MAAM,GAAG,CAAC,EAAE;MACzB,OAAOG,UAAU,CAACY,IAAI,CAAC,GAAG,CAAC,CAACC,IAAI,CAAC,CAAC,CAACC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;IACzD;EACF;EAEA,MAAMC,aAAa,GAAGzD,QAAQ,CAACU,KAAK,CAAC,YAAY,CAAC,IAAIV,QAAQ,CAACU,KAAK,CAACgD,kBAAkB;EACvF,IAAID,aAAa,EAAE;IACjB,OAAOA,aAAa;EACtB;;EAEA;EACA,IAAI,IAAAjC,+BAAW,EAACxB,QAAQ,CAAC,IAAIA,QAAQ,CAACU,KAAK,CAACe,GAAG,EAAE;IAC/C,OAAOzB,QAAQ,CAACU,KAAK,CAACe,GAAG;EAC3B;EAEA,OAAOpB,SAAS;AAClB;AAEA,SAASiC,oBAAoBA,CAACtC,QAAsB,EAAY;EAC9D,MAAM2D,cAAc,GAAG3D,QAAQ,CAACU,KAAK,CAAC,iBAAiB,CAAC;EACxD,IAAI,OAAOiD,cAAc,KAAK,QAAQ,EAAE;IACtC,OAAO,CAACA,cAAc,CAAC;EACzB;EAEA,MAAMC,uBAAuB,GAAG5D,QAAQ,CAACU,KAAK,CAACkD,uBAAuB;EACtE,IAAIC,KAAK,CAACC,OAAO,CAACF,uBAAuB,CAAC,EAAE;IAC1C,OAAOA,uBAAuB;EAChC;EAEA,IAAI,OAAOA,uBAAuB,KAAK,QAAQ,EAAE;IAC/C,OAAO,CAACA,uBAAuB,CAAC;EAClC;EAEA,OAAO,EAAE;AACX;;AAEA;AACO,SAASG,eAAeA,CAAC;EAAErD;AAAoB,CAAC,EAAW;EAChE,OAAOA,KAAK,CAAC,WAAW,CAAC,IAAIA,KAAK,CAACsD,kBAAkB,EAAEC,IAAI,IAAI,KAAK;AACtE;;AAEA;AACO,SAASC,kBAAkBA,CAAClE,QAAsB,EAAiC;EACxF,MAAM;IAAEU;EAAM,CAAC,GAAGV,QAAQ;EAE1B,IAAI,IAAA6B,gCAAY,EAAC7B,QAAQ,CAAC,EAAE;IAC1B,OAAOU,KAAK,CAACyD,KAAK;EACpB;EAEA,MAAMnC,IAAI,GAAGF,OAAO,CAAC9B,QAAQ,CAAC;EAC9B,IAAI,CAACoE,2BAA2B,CAACpC,IAAI,CAAC,EAAE;IACtC,OAAO3B,SAAS;EAClB;EAEA,OAAOK,KAAK,CAAC,cAAc,CAAC,IAAIA,KAAK,CAACsD,kBAAkB,EAAEK,OAAO;AACnE;;AAEA;AACO,SAASC,mBAAmBA,CAACtE,QAAsB,EAAW;EACnE,IAAI,IAAA4B,mCAAe,EAAC5B,QAAQ,CAAC,IAAI,CAAC,IAAAuE,8BAAmB,EAACvE,QAAQ,CAAC,EAAE;IAC/D,OAAO,IAAI;EACb;EAEA,MAAM;IAAEU;EAAM,CAAC,GAAGV,QAAQ;EAE1B,IAAI,IAAA2B,8BAAU,EAAC3B,QAAQ,CAAC,IAAIU,KAAK,CAAC8D,QAAQ,EAAE;IAC1C,OAAO,IAAI;EACb;EAEA,OAAO9D,KAAK,CAAC,eAAe,CAAC,IAAIA,KAAK,CAACsD,kBAAkB,EAAEQ,QAAQ,IAAI,KAAK;AAC9E;;AAEA;AACO,SAASC,mBAAmBA,CAAC;EAAE/D;AAAoB,CAAC,EAAuB;EAChF,OAAOA,KAAK,CAAC,eAAe,CAAC,IAAIA,KAAK,CAACsD,kBAAkB,EAAEU,QAAQ;AACrE;;AAEA;AACO,SAASC,mBAAmBA,CAAC;EAAEjE;AAAoB,CAAC,EAAW;EACpE,OAAOA,KAAK,CAAC,eAAe,CAAC,IAAIA,KAAK,CAACsD,kBAAkB,EAAEY,QAAQ,IAAI,KAAK;AAC9E;AAEO,SAASC,gBAAgBA,CAAC7E,QAAsB,EAAsB;EAC3E,MAAM;IACJ8E,kBAAkB;IAClB,eAAe,EAAEC,YAAY;IAC7B,eAAe,EAAEC,YAAY;IAC7B,eAAe,EAAEC,YAAY;IAC7B,gBAAgB,EAAEC;EACpB,CAAC,GAAGlF,QAAQ,CAACU,KAAK;EAElB,OAAO;IACLyE,GAAG,EAAEJ,YAAY,IAAID,kBAAkB,EAAEK,GAAG;IAC5CC,GAAG,EAAEJ,YAAY,IAAIF,kBAAkB,EAAEM,GAAG;IAC5CC,GAAG,EAAEJ,YAAY,IAAIH,kBAAkB,EAAEO,GAAG;IAC5CC,IAAI,EAAEJ,aAAa,IAAIJ,kBAAkB,EAAEQ;EAC7C,CAAC;AACH;AAMO,SAASC,qBAAqBA,CACnCvF,QAAsB,EACtBwF,OAAsC,EAClB;EACpB,MAAMC,KAAK,GAAGrD,gBAAgB,CAACpC,QAAQ,CAAC;EACxC,IAAIyF,KAAK,EAAE;IACT,OAAOA,KAAK;EACd;EAEA,IAAI,IAAA7D,mCAAe,EAAC5B,QAAQ,CAAC,IAAIA,QAAQ,CAACU,KAAK,CAACgF,WAAW,IAAIF,OAAO,EAAEG,IAAI,KAAK,KAAK,EAAE;IACtF,OAAO3F,QAAQ,CAACU,KAAK,CAACgF,WAAW;EACnC;EAEA,MAAME,KAAK,GAAG,EAAE;EAChB,KAAK,MAAMC,KAAK,IAAI7F,QAAQ,CAAC8F,QAAQ,EAAE;IACrC,IAAI,OAAOD,KAAK,KAAK,QAAQ,EAAE;MAC7B,IAAIA,KAAK,EAAE;QACTD,KAAK,CAACG,IAAI,CAACF,KAAK,CAAC;MACnB;IACF,CAAC,MAAM;MACL,MAAMG,UAAU,GAAGT,qBAAqB,CAACM,KAAK,EAAE;QAAEF,IAAI,EAAE;MAAM,CAAC,CAAC;MAChE,IAAIK,UAAU,EAAE;QACdJ,KAAK,CAACG,IAAI,CAACC,UAAU,CAAC;MACxB;IACF;EACF;EAEA,OAAOJ,KAAK,CAACtC,IAAI,CAAC,GAAG,CAAC;AACxB;AAIO,MAAMc,2BAA2C,GAAAvE,OAAA,CAAAuE,2BAAA,GAAG;EACzD6B,QAAQ,EAAE,IAAI;EACdC,KAAK,EAAE,IAAI;EACXC,MAAM,EAAE;AACV,CAAC","ignoreList":[]}

package/docs/README.md

@@ -0,0 +1,31 @@
+# React Native Testing Library package docs
+
+These markdown files are bundled with the npm package for coding agents. They describe the installed package version.
+
+Start with [LLM Guidelines](./guides/llm-guidelines.md) for rules overview, or use the included page list below to load specific references.
+
+## Included pages
+
+- [LLM Guidelines](./guides/llm-guidelines.md) - Quick rules for agents writing RNTL tests.
+- [Quick Start](./guides/quick-start.md) - Installation and setup basics.
+- [How to Query](./guides/how-to-query.md) - Query priority and selection guidance.
+- [Common Mistakes](./guides/common-mistakes.md) - Common anti-patterns and preferred alternatives.
+- [Troubleshooting](./guides/troubleshooting.md) - Common integration and runtime issues.
+- [Testing Environment](./guides/testing-environment.md) - How RNTL simulates React Native under tests.
+- [Understanding act](./guides/understanding-act.md) - How act warnings happen and how to resolve them.
+- [Migration to 14.x](./guides/migration-v14.md) - Breaking changes and upgrade steps for RNTL v14.
+- [API Overview](./api/overview.md) - Top-level API map.
+- [render](./api/render.md) - Rendering components in tests.
+- [screen](./api/screen.md) - Recommended global query surface.
+- [Queries](./api/queries.md) - Query variants and predicates.
+- [Jest Matchers](./api/jest-matchers.md) - Built-in RNTL assertions.
+- [User Event](./api/user-event.md) - Realistic user interactions.
+- [Fire Event](./api/fire-event.md) - Low-level event triggering.
+- [Async Utilities](./api/async-utilities.md) - Async queries and wait helpers.
+- [renderHook](./api/render-hook.md) - Testing custom hooks.
+- [Configuration](./api/configuration.md) - Runtime configuration options.
+- [Accessibility](./api/accessibility.md) - Accessibility helpers and hidden elements.
+- [Other Helpers](./api/other-helpers.md) - within, act, cleanup, and related helpers.
+- [Custom Render](./cookbook/custom-render.md) - Reusable render wrappers.
+- [Async Events](./cookbook/async-events.md) - Testing async interactions.
+- [Network Requests](./cookbook/network-requests.md) - Testing components that make network requests.

package/docs/api/accessibility.md

@@ -0,0 +1,26 @@
+# Accessibility
+
+## `isHiddenFromAccessibility`
+
+```ts
+function isHiddenFromAccessibility(instance: TestInstance | null): boolean {}
+```
+
+Also available as `isInaccessible()` alias for React Testing Library compatibility.
+
+Checks if given element is hidden from assistive technology, e.g. screen readers.
+
+> [!NOTE]
+> Like [`isInaccessible`](https://testing-library.com/docs/dom-testing-library/api-accessibility/#isinaccessible) function from DOM Testing Library this function considers both accessibility elements and presentational elements (regular `View`s) to be accessible, unless they are hidden in terms of host platform.
+>
+> This covers only part of [ARIA notion of Accessibility Tree](https://www.w3.org/TR/wai-aria-1.2/#tree_exclusion), as ARIA excludes both hidden and presentational elements from the Accessibility Tree.
+
+For the scope of this function, element is inaccessible when it, or any of its ancestors, meets any of the following conditions:
+
+- it has `display: none` style
+- it has [`aria-hidden`](https://reactnative.dev/docs/accessibility#aria-hidden) prop set to `true`
+- it has [`accessibilityElementsHidden`](https://reactnative.dev/docs/accessibility#accessibilityelementshidden-ios) prop set to `true`
+- it has [`importantForAccessibility`](https://reactnative.dev/docs/accessibility#importantforaccessibility-android) prop set to `no-hide-descendants`
+- it has sibling host element with either [`aria-modal`](https://reactnative.dev/docs/accessibility#aria-modal-ios) or [`accessibilityViewIsModal`](https://reactnative.dev/docs/accessibility#accessibilityviewismodal-ios) prop set to `true`
+
+Specifying `accessible={false}`, `role="none"`, `accessibilityRole="none"`, or `importantForAccessibility="no"` props does not cause the element to become inaccessible.

package/docs/api/async-utilities.md

@@ -0,0 +1,137 @@
+# Async utilities
+
+## `findBy*` queries
+
+The `findBy*` queries are used to find elements that are not instantly available but will be added as a result of some asynchronous action. Learn more details [here](./queries.md#find-by).
+
+## `waitFor`
+
+```tsx
+function waitFor<T>(
+  expectation: () => T,
+  options?: {
+    timeout?: number;
+    interval?: number;
+    onTimeout?: (error: Error) => Error;
+  },
+): Promise<T>;
+```
+
+Waits for the `expectation` callback to pass. `waitFor` runs the callback multiple times until timeout is reached, as specified by the `timeout` and `interval` options. The callback must throw an error when the expectation is not met. Returning any value, including a falsy one, is treated as meeting the expectation, and the callback result is returned to the caller.
+
+```tsx
+await waitFor(() => expect(mockFunction).toHaveBeenCalledWith());
+```
+
+`waitFor` executes the `expectation` callback every `interval` (default: 50 ms) until `timeout` (default: 1000 ms) is reached. Execution stops as soon as the callback doesn't throw an error, and the callback's return value is returned to the caller. If timeout is reached, `waitFor` re-throws the final error thrown by `expectation`.
+
+```tsx
+// ❌ `waitFor` will return immediately because callback does not throw
+await waitFor(() => false);
+```
+
+`waitFor` is an async function so you need to `await` the result to pause test execution.
+
+```jsx
+// ❌ missing `await`: `waitFor` will just return Promise that will be rejected when the timeout is reached
+waitFor(() => expect(1).toBe(2));
+```
+
+> [!NOTE]
+> You can enforce awaiting `waitFor` by using the [await-async-utils](https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/await-async-utils.md) rule from [eslint-plugin-testing-library](https://github.com/testing-library/eslint-plugin-testing-library).
+
+Since `waitFor` runs the `expectation` callback multiple times, [avoid performing side effects](https://kentcdodds.com/blog/common-mistakes-with-react-testing-library#performing-side-effects-in-waitfor) in `waitFor`.
+
+```jsx
+await waitFor(async () => {
+  // ❌ button will be pressed on each waitFor iteration
+  await fireEvent.press(screen.getByText('press me'));
+  expect(mockOnPress).toHaveBeenCalled();
+});
+```
+
+> [!NOTE]
+> Avoiding side effects in `expectation` callback can be partially enforced with the [`no-wait-for-side-effects` rule](https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/no-wait-for-side-effects.md).
+
+Use a [single assertion per `waitFor`](https://kentcdodds.com/blog/common-mistakes-with-react-testing-library#having-multiple-assertions-in-a-single-waitfor-callback) for consistency and faster failing tests. For multiple assertions, use separate `waitFor` calls. Often you won't need to wrap the second assertion in `waitFor` since the first one waits for the asynchronous change.
+
+`waitFor` checks whether Jest fake timers are enabled and adapts its behavior in such case. The following snippet is a simplified version of how it behaves when fake timers are enabled:
+
+```tsx
+let fakeTimeRemaining = timeout;
+let lastError;
+
+while (fakeTimeRemaining > 0) {
+  fakeTimeRemaining = fakeTimeRemaining - interval;
+  jest.advanceTimersByTime(interval);
+  try {
+    // resolve
+    return expectation();
+  } catch (error) {
+    lastError = error;
+  }
+}
+
+// reject
+throw lastError;
+```
+
+In the following example we test that a function is called after 10 seconds using fake timers. With fake timers, the test doesn't depend on real time passing, making it faster and more reliable. We don't need to advance fake timers through Jest's API because `waitFor` handles this.
+
+```tsx
+// in component
+setTimeout(() => {
+  someFunction();
+}, 10000);
+
+// in test
+jest.useFakeTimers();
+
+await waitFor(
+  () => {
+    expect(someFunction).toHaveBeenCalledWith();
+  },
+  { timeout: 10000 },
+);
+```
+
+> [!NOTE]
+> If you receive warnings related to `act()` function consult our [Understanding Act](../guides/understanding-act.md) function document.
+
+### Options
+
+- `timeout`: How long to wait for, in ms. Defaults to 1000 ms (configured by `asyncUtilTimeout` option).
+- `interval`: How often to check, in ms. Defaults to 50 ms.
+- `onTimeout`: Callback to transform the error before it's thrown. Useful for debugging, e.g., `onTimeout: () => { screen.debug(); }`.
+
+## `waitForElementToBeRemoved`
+
+```ts
+function waitForElementToBeRemoved<T>(
+  expectation: () => T,
+  options?: {
+    timeout?: number;
+    interval?: number;
+    onTimeout?: (error: Error) => Error;
+  },
+): Promise<T>;
+```
+
+Waits for non-deterministic periods of time until queried element is removed or times out. `waitForElementToBeRemoved` periodically calls `expectation` every `interval` milliseconds to determine whether the element has been removed or not.
+
+```jsx
+import { render, screen, waitForElementToBeRemoved } from '@testing-library/react-native';
+
+test('waiting for an Banana to be removed', async () => {
+  await render(<Banana />);
+
+  await waitForElementToBeRemoved(() => screen.getByText('Banana ready'));
+});
+```
+
+This method expects that the element is initially present in the render tree and then is removed from it. If the element is not present when you call this method it throws an error.
+
+You can use any of `getBy`, `getAllBy`, `queryBy` and `queryAllBy` queries for `expectation` parameter.
+
+> [!NOTE]
+> If you receive warnings related to `act()` function consult our [Understanding Act](../guides/understanding-act.md) function document.

package/docs/api/configuration.md

@@ -0,0 +1,61 @@
+# Configuration
+
+## `configure`
+
+```ts
+type Config = {
+  /** Default timeout, in ms, for `waitFor` and `findBy*` queries. */
+  asyncUtilTimeout: number;
+
+  /** Default value for `includeHiddenElements` query option. */
+  defaultIncludeHiddenElements: boolean;
+
+  /** Default options for `debug` helper. */
+  defaultDebugOptions?: Partial<DebugOptions>;
+};
+
+type ConfigAliasOptions = {
+  /** RTL-compatibility alias for `defaultIncludeHiddenElements`. */
+  defaultHidden: boolean;
+};
+
+function configure(options: Partial<Config & ConfigAliasOptions>) {}
+```
+
+### `asyncUtilTimeout` option
+
+Default timeout, in ms, for async helper functions (`waitFor`, `waitForElementToBeRemoved`) and `findBy*` queries. Defaults to 1000 ms.
+
+### `defaultIncludeHiddenElements` option
+
+Default value for [includeHiddenElements](./queries.md#includehiddenelements-option) query option for all queries. The default value is set to `false`, so all queries will not match [elements hidden from accessibility](#ishiddenfromaccessibility). This is because the users of the app would not be able to see such elements.
+
+This option is also available as `defaultHidden` alias for compatibility with [React Testing Library](https://testing-library.com/docs/dom-testing-library/api-configuration/#defaulthidden).
+
+### `defaultDebugOptions` option
+
+Default [debug options](#debug) to be used when calling `debug()`. These default options will be overridden by the ones you specify directly when calling `debug()`.
+
+## `resetToDefaults()`
+
+```ts
+function resetToDefaults() {}
+```
+
+## Environment variables
+
+### `RNTL_SKIP_AUTO_CLEANUP`
+
+Set to `true` to disable automatic `cleanup()` after each test. It works the same as importing `react-native-testing-library/dont-cleanup-after-each` or using `react-native-testing-library/pure`.
+
+```shell
+$ RNTL_SKIP_AUTO_CLEANUP=true jest
+```
+
+### `RNTL_SKIP_AUTO_DETECT_FAKE_TIMERS`
+
+Set to `true` to disable auto-detection of fake timers. This might be useful in rare cases when you want to use non-Jest fake timers. See [issue #886](https://github.com/callstack/react-native-testing-library/issues/886) for more details.
+
+```shell
+$ RNTL_SKIP_AUTO_DETECT_FAKE_TIMERS=true jest
+```

package/docs/api/fire-event.md

@@ -0,0 +1,165 @@
+# Fire Event API
+
+## `fireEvent`
+
+> [!NOTE]
+> For common events like `press` or `type`, use the [User Event API](./user-event.md). It simulates events more realistically by emitting a sequence of events with proper event objects that mimic React Native runtime behavior.
+>
+> Use Fire Event for cases not supported by User Event and for triggering event handlers on composite components.
+
+```ts
+function fireEvent(instance: TestInstance, eventName: string, ...data: unknown[]): Promise<unknown>;
+```
+
+The `fireEvent` API triggers event handlers on both host and composite components. It traverses the component tree bottom-up from the passed element to find an enabled event handler named `onXxx` where `xxx` is the event name.
+
+Unlike User Event, this API does not automatically pass event object to event handler, this is responsibility of the user to construct such object.
+
+The base `fireEvent(instance, eventName, ...data)` API can pass multiple custom arguments to the handler. Convenience helpers such as `fireEvent.press` and `fireEvent.scroll` are different: they create a default event object and accept one optional object to merge into it.
+
+This function uses async `act` internally to execute all pending React updates during event handling.
+
+```jsx
+import { render, screen, fireEvent } from '@testing-library/react-native';
+
+test('fire changeText event', async () => {
+  const onEventMock = jest.fn();
+  await render(
+    // MyComponent renders TextInput which has a placeholder 'Enter details'
+    // and with `onChangeText` bound to handleChangeText
+    <MyComponent handleChangeText={onEventMock} />,
+  );
+
+  await fireEvent(screen.getByPlaceholderText('change'), 'onChangeText', 'ab');
+  expect(onEventMock).toHaveBeenCalledWith('ab');
+});
+```
+
+> [!NOTE]
+> `fireEvent` performs checks that should prevent events firing on disabled elements.
+
+An example using `fireEvent` with native events that aren't already aliased by the `fireEvent` api.
+
+```jsx
+import { TextInput, View } from 'react-native';
+import { fireEvent, render, screen } from '@testing-library/react-native';
+
+const onBlurMock = jest.fn();
+
+await render(
+  <View>
+    <TextInput placeholder="my placeholder" onBlur={onBlurMock} />
+  </View>,
+);
+
+// you can omit the `on` prefix
+await fireEvent(screen.getByPlaceholderText('my placeholder'), 'blur');
+```
+
+FireEvent exposes convenience methods for common events like: `press`, `changeText`, `scroll`.
+
+### `fireEvent.press`
+
+> [!NOTE]
+> Use the User Event [`press()`](./user-event.md#press) helper instead. It simulates press interactions more realistically, including pressable support.
+
+```tsx
+fireEvent.press: (
+  instance: TestInstance,
+  eventProps?: Record<string, unknown>,
+) => Promise<void>
+```
+
+Builds a press event object, merges `eventProps` into it, and invokes the `press` handler on the element or nearest eligible parent.
+
+```jsx
+import { View, Text, TouchableOpacity } from 'react-native';
+import { render, screen, fireEvent } from '@testing-library/react-native';
+
+const onPressMock = jest.fn();
+const eventData = {
+  nativeEvent: {
+    pageX: 20,
+    pageY: 30,
+  },
+};
+
+await render(
+  <View>
+    <TouchableOpacity onPress={onPressMock}>
+      <Text>Press me</Text>
+    </TouchableOpacity>
+  </View>,
+);
+
+await fireEvent.press(screen.getByText('Press me'), eventData);
+expect(onPressMock).toHaveBeenCalledWith(expect.objectContaining(eventData));
+```
+
+### `fireEvent.changeText`
+
+> [!NOTE]
+> Use the User Event [`type()`](./user-event.md#type) helper instead. It simulates text change interactions more realistically, including key-by-key typing, element focus, and other editing events.
+
+```tsx
+fireEvent.changeText: (
+  instance: TestInstance,
+  text: string,
+) => Promise<void>
+```
+
+Invokes `changeText` event handler on the element or parent element in the tree.
+
+```jsx
+import { View, TextInput } from 'react-native';
+import { render, screen, fireEvent } from '@testing-library/react-native';
+
+const onChangeTextMock = jest.fn();
+const CHANGE_TEXT = 'content';
+
+await render(
+  <View>
+    <TextInput placeholder="Enter data" onChangeText={onChangeTextMock} />
+  </View>,
+);
+
+await fireEvent.changeText(screen.getByPlaceholderText('Enter data'), CHANGE_TEXT);
+```
+
+### `fireEvent.scroll`
+
+> [!NOTE]
+> Prefer [`user.scrollTo`](./user-event.md#scrollto) over `fireEvent.scroll` for `ScrollView`, `FlatList`, and `SectionList` components. User Event simulates events more realistically based on React Native runtime behavior.
+
+```tsx
+fireEvent.scroll: (
+  instance: TestInstance,
+  eventProps?: Record<string, unknown>,
+) => Promise<void>
+```
+
+Builds a scroll event object, merges `eventProps` into it, and invokes the `scroll` handler on the element or nearest eligible parent.
+
+#### On a `ScrollView`
+
+```jsx
+import { ScrollView, Text } from 'react-native';
+import { render, screen, fireEvent } from '@testing-library/react-native';
+
+const onScrollMock = jest.fn();
+const eventData = {
+  nativeEvent: {
+    contentOffset: {
+      y: 200,
+    },
+  },
+};
+
+await render(
+  <ScrollView testID="scroll-view" onScroll={onScrollMock}>
+    <Text>Content</Text>
+  </ScrollView>,
+);
+
+await fireEvent.scroll(screen.getByTestId('scroll-view'), eventData);
+```