react-native-a11y-container

react-native-a11y-container

ReactNative UIAccessibilityContainer Component.

The VoiceOver rotor offers enhanced navigation options. To define containers for the rotor, use the react-native-a11y-container and A11yContainerView components.

⚡️ New architecture compatible!

Installation

npm install react-native-a11y-container
cd ios && pod install && cd ..

or

yarn add react-native-a11y-container
cd ios && pod install && cd ..

Usage

import { A11yContainerView } from "react-native-a11y-container";

// ...

<A11yContainerView>{children}</A11yContainerView>

//or

<A11yContainerView type="List"/>{children}</A11yContainerView>

To specify the type of content within A11yContainerView, use the type attribute with the following values:

• None corresponds to UIAccessibilityContainerTypeNone
• DataTable corresponds to UIAccessibilityContainerTypeDataTable Note: Avoid using DataTable unless you implement the UIAccessibilityContainerDataTable protocol as required.
• List corresponds to UIAccessibilityContainerTypeList
• Landmark corresponds to UIAccessibilityContainerTypeLandmark
• SemanticGroup corresponds to UIAccessibilityContainerTypeSemanticGroup

By default, A11yContainerView uses the SemanticGroup type. For more details on these types, refer to the developer.apple.com documentation.

Platforms

This library is designed for implementing UIAccessibilityContainer logic in React Native. While UIAccessibilityContainer is specific to iOS, there are no equivalent components for other platforms. For non-iOS platforms, a basic View is used.

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT

Made with create-react-native-library