Skip to content

Commit

Permalink
add documentation for aria-modal prop (#3320)
Browse files Browse the repository at this point in the history
  • Loading branch information
dakshbhardwaj authored Sep 23, 2022
1 parent 94c5e80 commit 4260478
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/accessibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,16 @@ A Boolean value indicating whether the accessibility elements contained within t

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"`.

### `aria-modal` <div class="label ios">iOS</div>

Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver.

| Type | Default |
| ---- | ------- |
| bool | false |

---

### `importantForAccessibility` <div class="label android">Android</div>

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).
Expand Down
10 changes: 10 additions & 0 deletions docs/view.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,16 @@ When `true`, indicates that the view is an accessibility element. By default, al

---

### `aria-modal` <div class="label ios">iOS</div>

Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. Has precedence over the `accessibilityViewIsModal` prop.

| Type | Default |
| ---- | ------- |
| bool | false |

---

### `collapsable` <div class="label android">Android</div>

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.
Expand Down

0 comments on commit 4260478

Please sign in to comment.