refactor: rename isInaccessible

Author: mdjastrzebski

src/helpers/__tests__/accessiblity.test.tsx

@@ -1,28 +1,30 @@
 import React from 'react';
 import { View, Text, TextInput } from 'react-native';
-import { render, isInaccessible } from '../..';
+import { render, isHiddenFromAccessibility } from '../..';
 
 test('returns false for accessible elements', () => {
   expect(
-    isInaccessible(render(<View testID="subject" />).getByTestId('subject'))
+    isHiddenFromAccessibility(
+      render(<View testID="subject" />).getByTestId('subject')
+    )
   ).toBe(false);
 
   expect(
-    isInaccessible(
+    isHiddenFromAccessibility(
       render(<Text testID="subject">Hello</Text>).getByTestId('subject')
     )
   ).toBe(false);
 
   expect(
-    isInaccessible(
+    isHiddenFromAccessibility(
       render(<TextInput testID="subject" />).getByTestId('subject')
     )
   ).toBe(false);
 });
 
 test('detects elements with accessibilityElementsHidden prop', () => {
   const view = render(<View testID="subject" accessibilityElementsHidden />);
-  expect(isInaccessible(view.getByTestId('subject'))).toBe(true);
+  expect(isHiddenFromAccessibility(view.getByTestId('subject'))).toBe(true);
 });
 
 test('detects nested elements with accessibilityElementsHidden prop', () => {
@@ -31,7 +33,7 @@ test('detects nested elements with accessibilityElementsHidden prop', () => {
       <View testID="subject" />
     </View>
   );
-  expect(isInaccessible(view.getByTestId('subject'))).toBe(true);
+  expect(isHiddenFromAccessibility(view.getByTestId('subject'))).toBe(true);
 });
 
 test('detects deeply nested elements with accessibilityElementsHidden prop', () => {
@@ -44,14 +46,14 @@ test('detects deeply nested elements with accessibilityElementsHidden prop', ()
       </View>
     </View>
   );
-  expect(isInaccessible(view.getByTestId('subject'))).toBe(true);
+  expect(isHiddenFromAccessibility(view.getByTestId('subject'))).toBe(true);
 });
 
 test('detects elements with importantForAccessibility="no-hide-descendants" prop', () => {
   const view = render(
     <View testID="subject" importantForAccessibility="no-hide-descendants" />
   );
-  expect(isInaccessible(view.getByTestId('subject'))).toBe(true);
+  expect(isHiddenFromAccessibility(view.getByTestId('subject'))).toBe(true);
 });
 
 test('detects nested elements with importantForAccessibility="no-hide-descendants" prop', () => {
@@ -60,12 +62,12 @@ test('detects nested elements with importantForAccessibility="no-hide-descendant
       <View testID="subject" />
     </View>
   );
-  expect(isInaccessible(view.getByTestId('subject'))).toBe(true);
+  expect(isHiddenFromAccessibility(view.getByTestId('subject'))).toBe(true);
 });
 
 test('detects elements with display=none', () => {
   const view = render(<View testID="subject" style={{ display: 'none' }} />);
-  expect(isInaccessible(view.getByTestId('subject'))).toBe(true);
+  expect(isHiddenFromAccessibility(view.getByTestId('subject'))).toBe(true);
 });
 
 test('detects nested elements with display=none', () => {
@@ -74,7 +76,7 @@ test('detects nested elements with display=none', () => {
       <View testID="subject" />
     </View>
   );
-  expect(isInaccessible(view.getByTestId('subject'))).toBe(true);
+  expect(isHiddenFromAccessibility(view.getByTestId('subject'))).toBe(true);
 });
 
 test('detects deeply nested elements with display=none', () => {
@@ -87,7 +89,7 @@ test('detects deeply nested elements with display=none', () => {
       </View>
     </View>
   );
-  expect(isInaccessible(view.getByTestId('subject'))).toBe(true);
+  expect(isHiddenFromAccessibility(view.getByTestId('subject'))).toBe(true);
 });
 
 test('detects elements with display=none with complex style', () => {
@@ -97,12 +99,12 @@ test('detects elements with display=none with complex style', () => {
       style={[{ display: 'flex' }, [{ display: 'flex' }], { display: 'none' }]}
     />
   );
-  expect(isInaccessible(view.getByTestId('subject'))).toBe(true);
+  expect(isHiddenFromAccessibility(view.getByTestId('subject'))).toBe(true);
 });
 
 test('is not trigged by opacity = 0', () => {
   const view = render(<View testID="subject" style={{ opacity: 0 }} />);
-  expect(isInaccessible(view.getByTestId('subject'))).toBe(false);
+  expect(isHiddenFromAccessibility(view.getByTestId('subject'))).toBe(false);
 });
 
 test('detects siblings of element with accessibilityViewIsModal prop', () => {
@@ -112,7 +114,7 @@ test('detects siblings of element with accessibilityViewIsModal prop', () => {
       <View testID="subject" />
     </View>
   );
-  expect(isInaccessible(view.getByTestId('subject'))).toBe(true);
+  expect(isHiddenFromAccessibility(view.getByTestId('subject'))).toBe(true);
 });
 
 test('detects deeply nested siblings of element with accessibilityViewIsModal prop', () => {
@@ -126,7 +128,7 @@ test('detects deeply nested siblings of element with accessibilityViewIsModal pr
       </View>
     </View>
   );
-  expect(isInaccessible(view.getByTestId('subject'))).toBe(true);
+  expect(isHiddenFromAccessibility(view.getByTestId('subject'))).toBe(true);
 });
 
 test('is not triggered for element with accessibilityViewIsModal prop', () => {
@@ -135,7 +137,7 @@ test('is not triggered for element with accessibilityViewIsModal prop', () => {
       <View accessibilityViewIsModal testID="subject" />
     </View>
   );
-  expect(isInaccessible(view.getByTestId('subject'))).toBe(false);
+  expect(isHiddenFromAccessibility(view.getByTestId('subject'))).toBe(false);
 });
 
 test('is not triggered for child of element with accessibilityViewIsModal prop', () => {
@@ -146,7 +148,7 @@ test('is not triggered for child of element with accessibilityViewIsModal prop',
       </View>
     </View>
   );
-  expect(isInaccessible(view.getByTestId('subject'))).toBe(false);
+  expect(isHiddenFromAccessibility(view.getByTestId('subject'))).toBe(false);
 });
 
 test('is not triggered for descendent of element with accessibilityViewIsModal prop', () => {
@@ -161,5 +163,5 @@ test('is not triggered for descendent of element with accessibilityViewIsModal p
       </View>
     </View>
   );
-  expect(isInaccessible(view.getByTestId('subject'))).toBe(false);
+  expect(isHiddenFromAccessibility(view.getByTestId('subject'))).toBe(false);
 });

src/helpers/accessiblity.ts

@@ -16,7 +16,7 @@ export const accessibilityStateKeys: AccessibilityStateKey[] = [
   'expanded',
 ];
 
-export function isInaccessible(
+export function isHiddenFromAccessibility(
   element: ReactTestInstance | null,
   { cache }: IsInaccessibleOptions = {}
 ): boolean {
@@ -43,9 +43,10 @@ export function isInaccessible(
   return false;
 }
 
-export function isSubtreeInaccessible(
-  element: ReactTestInstance | null
-): boolean {
+/** RTL-compatitibility alias for `isHiddenFromAccessibility` */
+export const isInaccessible = isHiddenFromAccessibility;
+
+function isSubtreeInaccessible(element: ReactTestInstance | null): boolean {
   if (element == null) {
     return true;
   }

src/pure.ts

@@ -8,7 +8,10 @@ import { within, getQueriesForElement } from './within';
 import { getDefaultNormalizer } from './matches';
 import { renderHook } from './renderHook';
 import { screen } from './screen';
-import { isInaccessible } from './helpers/accessiblity';
+export {
+  isHiddenFromAccessibility,
+  isInaccessible,
+} from './helpers/accessiblity';
 
 export type {
   RenderOptions,
@@ -29,4 +32,3 @@ export { within, getQueriesForElement };
 export { getDefaultNormalizer };
 export { renderHook };
 export { screen };
-export { isInaccessible };