Skip to content

Commit 4260478

Browse files
add documentation for aria-modal prop (facebook#3320)
1 parent 94c5e80 commit 4260478

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

docs/accessibility.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,16 @@ A Boolean value indicating whether the accessibility elements contained within t
204204

205205
For example, in a window that contains sibling views `A` and `B`, setting `accessibilityElementsHidden` to `true` on view `B` causes VoiceOver to ignore the elements in the view `B`. This is similar to the Android property `importantForAccessibility="no-hide-descendants"`.
206206

207+
### `aria-modal` <div class="label ios">iOS</div>
208+
209+
Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver.
210+
211+
| Type | Default |
212+
| ---- | ------- |
213+
| bool | false |
214+
215+
---
216+
207217
### `importantForAccessibility` <div class="label android">Android</div>
208218

209219
In the case of two overlapping UI components with the same parent, default accessibility focus can have unpredictable behavior. The `importantForAccessibility` property will resolve this by controlling if a view fires accessibility events and if it is reported to accessibility services. It can be set to `auto`, `yes`, `no` and `no-hide-descendants` (the last value will force accessibility services to ignore the component and all of its children).

docs/view.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,16 @@ When `true`, indicates that the view is an accessibility element. By default, al
249249

250250
---
251251

252+
### `aria-modal` <div class="label ios">iOS</div>
253+
254+
Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. Has precedence over the `accessibilityViewIsModal` prop.
255+
256+
| Type | Default |
257+
| ---- | ------- |
258+
| bool | false |
259+
260+
---
261+
252262
### `collapsable` <div class="label android">Android</div>
253263

254264
Views that are only used to layout their children or otherwise don't draw anything may be automatically removed from the native hierarchy as an optimization. Set this property to `false` to disable this optimization and ensure that this `View` exists in the native view hierarchy.

0 commit comments

Comments
 (0)