Add accessibilityElementsHidden prop (#141)

facebook · Mar 14, 2018 · 0289c28 · 0289c28
1 parent 48b9b15
commit 0289c28
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/docs/accessibility.md b/docs/accessibility.md
@@ -77,6 +77,13 @@ A Boolean value indicating whether VoiceOver should ignore the elements within v
 
 For example, in a window that contains sibling views `A` and `B`, setting `accessibilityViewIsModal` to `true` on view `B` causes VoiceOver to ignore the elements in the view `A`. On the other hand, if view `B` contains a child view `C` and you set `accessibilityViewIsModal` to `true` on view `C`, VoiceOver does not ignore the elements in view `A`.
 
+
+#### accessibilityElementsHidden (iOS)
+
+A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden.
+
+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"`.
+
 #### onAccessibilityTap (iOS)
 
 Use this property to assign a custom function to be called when someone activates an accessible element by double tapping on it while it's selected.

diff --git a/docs/view.md b/docs/view.md
@@ -76,6 +76,7 @@ For `View` responder props (e.g., `onResponderMove`), the synthetic touch event
 * [`renderToHardwareTextureAndroid`](view.md#rendertohardwaretextureandroid)
 * [`accessibilityTraits`](view.md#accessibilitytraits)
 * [`accessibilityViewIsModal`](view.md#accessibilityviewismodal)
+* [`accessibilityElementsHidden`](view.md#accessibilityElementsHidden)
 * [`shouldRasterizeIOS`](view.md#shouldrasterizeios)
 
 ---
@@ -474,7 +475,19 @@ See the [Accessibility guide](accessibility.md#accessibilitytraits-ios) for more
 
 A value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. Default is `false`.
 
-See the [Accessibility guide](accessibility.md#accessibilitytraits-ios) for more information.
+See the [Accessibility guide](accessibility.md#accessibilityviewismodal-ios) for more information.
+
+| Type | Required | Platform |
+| ---- | -------- | -------- |
+| bool | No       | iOS      |
+
+---
+
+### `accessibilityElementsHidden`
+
+A value indicating whether the accessibility elements contained within this accessibility element are hidden. Default is `false`.
+
+See the [Accessibility guide](accessibility.md#accessibilityelementshidden-ios) for more information.
 
 | Type | Required | Platform |
 | ---- | -------- | -------- |