Skip to content

Commit 1246baf

Browse files
committed
feat: Update description and example
1 parent 5a22737 commit 1246baf

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

README.md

+5
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,12 @@ The VoiceOver rotor offers enhanced navigation options. To define containers for
1010

1111
```sh
1212
npm install react-native-a11y-container
13+
cd ios && pod install && cd ..
1314
```
1415
or
1516
```sh
1617
yarn add react-native-a11y-container
18+
cd ios && pod install && cd ..
1719
```
1820

1921
## Usage
@@ -40,6 +42,9 @@ To specify the type of content within A11yContainerView, use the type attribute
4042
By default, A11yContainerView uses the SemanticGroup type. For more details on these types, refer to the developer.apple.com documentation.
4143

4244

45+
## Platforms
46+
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.
47+
4348
## Contributing
4449

4550
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

example/src/App.tsx

+7-6
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ export default function App() {
77
return (
88
<View style={styles.container}>
99
<A11yContainerView accessibilityLabel="VoiceOver Rotor info">
10-
<Text accessibilityRole="header">Use the VoiceOver rotor</Text>
10+
<Text style={styles.header} accessibilityRole="header">
11+
Use the VoiceOver rotor
12+
</Text>
1113
<Text>
1214
First, if you haven't turned on VoiceOver, turn it on in Settings &gt;
1315
Accessibility.
@@ -24,7 +26,7 @@ export default function App() {
2426
</Text>
2527
</A11yContainerView>
2628
<A11yContainerView>
27-
<Text accessibilityRole="header">
29+
<Text style={styles.header} accessibilityRole="header">
2830
Move through the organization of a page or screen
2931
</Text>
3032
<Text>
@@ -41,10 +43,9 @@ const styles = StyleSheet.create({
4143
flex: 1,
4244
alignItems: 'center',
4345
justifyContent: 'center',
46+
padding: 30,
4447
},
45-
box: {
46-
width: 60,
47-
height: 60,
48-
marginVertical: 20,
48+
header: {
49+
fontWeight: '600',
4950
},
5051
});

0 commit comments

Comments
 (0)