feat: toHaveAccessibleName matcher

callstack · Oct 31, 2023 · 6cd8734 · 6cd8734
1 parent 4445c33
commit 6cd8734
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 43 deletions.
diff --git a/src/helpers/accessiblity.ts b/src/helpers/accessiblity.ts
@@ -4,7 +4,8 @@ import {
   StyleSheet,
 } from 'react-native';
 import { ReactTestInstance } from 'react-test-renderer';
-import { getHostSiblings } from './component-tree';
+import { getTextContent } from './text-content';
+import { getHostSiblings, getUnsafeRootElement } from './component-tree';
 import { getHostComponentNames } from './host-component-names';
 
 type IsInaccessibleOptions = {
@@ -233,3 +234,23 @@ export function isElementSelected(
   const { accessibilityState, 'aria-selected': ariaSelected } = element.props;
   return ariaSelected ?? accessibilityState?.selected ?? false;
 }
+
+export function getAccessibleName(
+  element: ReactTestInstance
+): string | undefined {
+  const labelTextFromLabel = getAccessibilityLabel(element);
+  const labelTextFromLabelledBy = getAccessibilityLabelledBy(element);
+  const rootElement = getUnsafeRootElement(element);
+
+  const labelledByElement = labelTextFromLabelledBy
+    ? rootElement?.findByProps({
+        nativeID: labelTextFromLabelledBy,
+      })
+    : undefined;
+
+  const nameFromLabel = labelTextFromLabelledBy
+    ? labelledByElement && getTextContent(labelledByElement)
+    : labelTextFromLabel;
+
+  return nameFromLabel || getTextContent(element) || undefined;
+}
diff --git a/src/helpers/matchers/accessibilityName.ts b/src/helpers/matchers/accessibilityName.ts
diff --git a/src/matchers/to-have-accessible-name.tsx b/src/matchers/to-have-accessible-name.tsx
@@ -1,33 +1,22 @@
 import type { ReactTestInstance } from 'react-test-renderer';
 import { matcherHint } from 'jest-matcher-utils';
-import { matchAccessibleName } from '../helpers/matchers/accessibilityName';
-import {
-  getAccessibilityLabel,
-  getAccessibilityLabelledBy,
-} from '../helpers/accessiblity';
-import { TextMatch, TextMatchOptions } from '../matches';
-import { getTextContent } from '../helpers/text-content';
-import { getUnsafeRootElement } from '../helpers/component-tree';
+import { TextMatch, TextMatchOptions, matches } from '../matches';
+import { getAccessibleName } from '../helpers/accessiblity';
 import { checkHostElement, formatMessage } from './utils';
 
-export function getAccessibleName(
-  element: ReactTestInstance
-): string | undefined {
-  const labelTextFromLabel = getAccessibilityLabel(element);
-  const labelTextFromLabelledBy = getAccessibilityLabelledBy(element);
-  const rootElement = getUnsafeRootElement(element);
-
-  const labelledByElement = labelTextFromLabelledBy
-    ? rootElement?.findByProps({
-        nativeID: labelTextFromLabelledBy,
-      })
-    : undefined;
+export function matchAccessibleName(
+  node: ReactTestInstance,
+  expectedName?: TextMatch,
+  normalizer?: TextMatchOptions['normalizer'],
+  exact?: TextMatchOptions['exact']
+): boolean {
+  const accessibleName = getAccessibleName(node);
 
-  const nameFromLabel = labelTextFromLabelledBy
-    ? labelledByElement && getTextContent(labelledByElement)
-    : labelTextFromLabel;
+  if (expectedName) {
+    return matches(expectedName, accessibleName, normalizer, exact);
+  }
 
-  return nameFromLabel || getTextContent(element) || undefined;
+  return !!accessibleName;
 }
 
 export function toHaveAccessibleName(