Skip to content

Commit 469d3d2

Browse files
authored
Reword accessible prop in accessiblity guide (facebook#4656)
1 parent fec2f1f commit 469d3d2

File tree

8 files changed

+44
-28
lines changed

8 files changed

+44
-28
lines changed

docs/accessibility.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,20 @@ Android and iOS differ slightly in their approaches, and thus the React Native i
1414

1515
### `accessible`
1616

17-
When `true`, indicates that the view is an accessibility element. When a view is an accessibility element, it groups its children into a single selectable component. By default, all touchable elements are accessible.
17+
When `true`, indicates that the view is discoverable by assistive technologies such as screen readers and hardware keyboards. Note that this does not necessarily mean that the view will be focused by VoiceOver or TalkBack. There are a number of reasons for this, such as VoiceOver disallowing nested acecssibility elements, or TalkBack opting to focus some parent element instead.
1818

19-
On Android, `accessible={true}` property for a react-native View will be translated into native `focusable={true}`.
19+
By default, all touchable elements are accessible.
20+
21+
On Android, `accessible` will be translated into native [`focusable`](<https://developer.android.com/reference/android/view/View#setFocusable(boolean)>). On iOS, it translates into native [`isAccessibilityElement`](https://developer.apple.com/documentation/uikit/uiaccessibilityelement/isaccessibilityelement?language=objc).
2022

2123
```tsx
22-
<View accessible={true}>
23-
<Text>text one</Text>
24-
<Text>text two</Text>
24+
<View>
25+
<View accessible={true} />
26+
<View />
2527
</View>
2628
```
2729

28-
In the above example, accessibility focus is only available on the parent view with the `accessible` property, and not individually for 'text one' and 'text two'.
30+
In the above example, accessibility focus is only available on the first child view with the `accessible` property, and not for the parent or sibling without `accessible`.
2931

3032
### `accessibilityLabel`
3133

docs/view.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,9 @@ See the [Accessibility guide](accessibility.md#accessibilityviewismodal-ios) for
206206

207207
### `accessible`
208208

209-
When `true`, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
209+
When `true`, indicates that the view is an accessibility element and discoverable by assistive technologies such as screen readers and hardware keyboards. By default, all the touchable elements are accessible.
210+
211+
See the [Accessibility guide](accessibility.md#accessible) for more information.
210212

211213
---
212214

website/versioned_docs/version-0.78/accessibility.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,20 @@ Android and iOS differ slightly in their approaches, and thus the React Native i
1414

1515
### `accessible`
1616

17-
When `true`, indicates that the view is an accessibility element. When a view is an accessibility element, it groups its children into a single selectable component. By default, all touchable elements are accessible.
17+
When `true`, indicates that the view is discoverable by assistive technologies such as screen readers and hardware keyboards. Note that this does not necessarily mean that the view will be focused by VoiceOver or TalkBack. There are a number of reasons for this, such as VoiceOver disallowing nested acecssibility elements, or TalkBack opting to focus some parent element instead.
1818

19-
On Android, `accessible={true}` property for a react-native View will be translated into native `focusable={true}`.
19+
By default, all touchable elements are accessible.
20+
21+
On Android, `accessible` will be translated into native [`focusable`](<https://developer.android.com/reference/android/view/View#setFocusable(boolean)>). On iOS, it translates into native [`isAccessibilityElement`](https://developer.apple.com/documentation/uikit/uiaccessibilityelement/isaccessibilityelement?language=objc).
2022

2123
```tsx
22-
<View accessible={true}>
23-
<Text>text one</Text>
24-
<Text>text two</Text>
24+
<View>
25+
<View accessible={true} />
26+
<View />
2527
</View>
2628
```
2729

28-
In the above example, accessibility focus is only available on the parent view with the `accessible` property, and not individually for 'text one' and 'text two'.
30+
In the above example, accessibility focus is only available on the first child view with the `accessible` property, and not for the parent or sibling without `accessible`.
2931

3032
### `accessibilityLabel`
3133

website/versioned_docs/version-0.78/view.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,9 @@ See the [Accessibility guide](accessibility.md#accessibilityviewismodal-ios) for
206206

207207
### `accessible`
208208

209-
When `true`, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
209+
When `true`, indicates that the view is an accessibility element and discoverable by assistive technologies such as screen readers and hardware keyboards. By default, all the touchable elements are accessible.
210+
211+
See the [Accessibility guide](accessibility.md#accessible) for more information.
210212

211213
---
212214

website/versioned_docs/version-0.79/accessibility.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,20 @@ Android and iOS differ slightly in their approaches, and thus the React Native i
1414

1515
### `accessible`
1616

17-
When `true`, indicates that the view is an accessibility element. When a view is an accessibility element, it groups its children into a single selectable component. By default, all touchable elements are accessible.
17+
When `true`, indicates that the view is discoverable by assistive technologies such as screen readers and hardware keyboards. Note that this does not necessarily mean that the view will be focused by VoiceOver or TalkBack. There are a number of reasons for this, such as VoiceOver disallowing nested acecssibility elements, or TalkBack opting to focus some parent element instead.
1818

19-
On Android, `accessible={true}` property for a react-native View will be translated into native `focusable={true}`.
19+
By default, all touchable elements are accessible.
20+
21+
On Android, `accessible` will be translated into native [`focusable`](<https://developer.android.com/reference/android/view/View#setFocusable(boolean)>). On iOS, it translates into native [`isAccessibilityElement`](https://developer.apple.com/documentation/uikit/uiaccessibilityelement/isaccessibilityelement?language=objc).
2022

2123
```tsx
22-
<View accessible={true}>
23-
<Text>text one</Text>
24-
<Text>text two</Text>
24+
<View>
25+
<View accessible={true} />
26+
<View />
2527
</View>
2628
```
2729

28-
In the above example, accessibility focus is only available on the parent view with the `accessible` property, and not individually for 'text one' and 'text two'.
30+
In the above example, accessibility focus is only available on the first child view with the `accessible` property, and not for the parent or sibling without `accessible`.
2931

3032
### `accessibilityLabel`
3133

website/versioned_docs/version-0.79/view.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,9 @@ See the [Accessibility guide](accessibility.md#accessibilityviewismodal-ios) for
206206

207207
### `accessible`
208208

209-
When `true`, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
209+
When `true`, indicates that the view is an accessibility element and discoverable by assistive technologies such as screen readers and hardware keyboards. By default, all the touchable elements are accessible.
210+
211+
See the [Accessibility guide](accessibility.md#accessible) for more information.
210212

211213
---
212214

website/versioned_docs/version-0.80/accessibility.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,20 @@ Android and iOS differ slightly in their approaches, and thus the React Native i
1414

1515
### `accessible`
1616

17-
When `true`, indicates that the view is an accessibility element. When a view is an accessibility element, it groups its children into a single selectable component. By default, all touchable elements are accessible.
17+
When `true`, indicates that the view is discoverable by assistive technologies such as screen readers and hardware keyboards. Note that this does not necessarily mean that the view will be focused by VoiceOver or TalkBack. There are a number of reasons for this, such as VoiceOver disallowing nested acecssibility elements, or TalkBack opting to focus some parent element instead.
1818

19-
On Android, `accessible={true}` property for a react-native View will be translated into native `focusable={true}`.
19+
By default, all touchable elements are accessible.
20+
21+
On Android, `accessible` will be translated into native [`focusable`](<https://developer.android.com/reference/android/view/View#setFocusable(boolean)>). On iOS, it translates into native [`isAccessibilityElement`](https://developer.apple.com/documentation/uikit/uiaccessibilityelement/isaccessibilityelement?language=objc).
2022

2123
```tsx
22-
<View accessible={true}>
23-
<Text>text one</Text>
24-
<Text>text two</Text>
24+
<View>
25+
<View accessible={true} />
26+
<View />
2527
</View>
2628
```
2729

28-
In the above example, accessibility focus is only available on the parent view with the `accessible` property, and not individually for 'text one' and 'text two'.
30+
In the above example, accessibility focus is only available on the first child view with the `accessible` property, and not for the parent or sibling without `accessible`.
2931

3032
### `accessibilityLabel`
3133

website/versioned_docs/version-0.80/view.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,9 @@ See the [Accessibility guide](accessibility.md#accessibilityviewismodal-ios) for
206206

207207
### `accessible`
208208

209-
When `true`, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
209+
When `true`, indicates that the view is an accessibility element and discoverable by assistive technologies such as screen readers and hardware keyboards. By default, all the touchable elements are accessible.
210+
211+
See the [Accessibility guide](accessibility.md#accessible) for more information.
210212

211213
---
212214

0 commit comments

Comments
 (0)