diff --git a/docs/next/accessibility.html b/docs/next/accessibility.html index ff72e2023b5..9096d5c803b 100644 --- a/docs/next/accessibility.html +++ b/docs/next/accessibility.html @@ -103,9 +103,6 @@
Inverting screen colors is an Accessibility feature that makes the iPhone and iPad easier on the eyes for some people with a sensitivity to brightness, easier to distinguish for some people with color blindness, and easier to make out for some people with low vision. However, sometimes you have views such as photos that you don't want to be inverted. In this case, you can set this property to be false so that these specific views won't have their colors inverted.
-Note: Accessibility Role and Accessibility States are meant to be a cross-platform solution to replace
-accessibilityTraitsandaccessibilityComponentType, which will soon be deprecated. When possible, useaccessibilityRoleandaccessibilityStatesinstead ofaccessibilityTraitsandaccessibilityComponentType.
Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on. To use, set the accessibilityRole property to one of the following strings:
-Note: >
-accessibilityRoleandaccessibilityStatesare meant to be a cross-platform solution to replaceaccessibilityTraitsandaccessibilityComponentType, which will soon be deprecated. When possible, useaccessibilityRoleandaccessibilityStatesinstead ofaccessibilityTraitsandaccessibilityComponentType.
Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on. The state of the element can be set either to selected or disabled or both:
To use, set the accessibilityStates to an array containing either selected, disabled, or both.
--Note:
-accessibilityTraitswill soon be deprecated. When possible, useaccessibilityRoleandaccessibilityStatesinstead ofaccessibilityTraitsandaccessibilityComponentType.
Accessibility traits tell a person using VoiceOver what kind of element they have selected. Is this element a label? A button? A header? These questions are answered by accessibilityTraits.
To use, set the accessibilityTraits property to one of (or an array of) accessibility trait strings:
A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver.
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.
Assign this property to a custom function which will be called when someone performs the "magic tap" gesture, which is a double-tap with two fingers. A magic tap function should perform the most relevant action a user could take on a component. In the Phone app on iPhone, a magic tap answers a phone call, or ends the current one. If the selected element does not have an onMagicTap function, the system will traverse up the view hierarchy until it finds a view that does.
Assign this property to a custom function which will be called when someone performs the "escape" gesture, which is a two finger Z shaped gesture. An escape function should move back hierarchically in the user interface. This can mean moving up or back in a navigation hierarchy or dismissing a modal user interface. If the selected element does not have an onAccessibilityEscape function, the system will attempt to traverse up the view hierarchy until it finds a view that does or bonk to indicate it was unable to find one.
--Note: >
-accessibilityComponentTypewill soon be deprecated. When possible, useaccessibilityRoleandaccessibilityStatesinstead ofaccessibilityTraitsandaccessibilityComponentType.
In some cases, we also want to alert the end user of the type of selected component (i.e., that it is a “button”). If we were using native buttons, this would work automatically. Since we are using javascript, we need to provide a bit more context for TalkBack. To do so, you must specify the ‘accessibilityComponentType’ property for any UI component. We support 'none', ‘button’, ‘radiobutton_checked’ and ‘radiobutton_unchecked’.
-<TouchableWithoutFeedback accessibilityComponentType=”button”
- onPress={this._onPress}>
- <View style={styles.button}>
- <Text style={styles.buttonText}>Press me!</Text>
- </View>
-</TouchableWithoutFeedback>
-
-In the above example, the TouchableWithoutFeedback is being announced by TalkBack as a native Button.
When components dynamically change, we want TalkBack to alert the end user. This is made possible by the ‘accessibilityLiveRegion’ property. It can be set to ‘none’, ‘polite’ and ‘assertive’:
Inverting screen colors is an Accessibility feature that makes the iPhone and iPad easier on the eyes for some people with a sensitivity to brightness, easier to distinguish for some people with color blindness, and easier to make out for some people with low vision. However, sometimes you have views such as photos that you don't want to be inverted. In this case, you can set this property to be false so that these specific views won't have their colors inverted.
-Note: Accessibility Role and Accessibility States are meant to be a cross-platform solution to replace
-accessibilityTraitsandaccessibilityComponentType, which will soon be deprecated. When possible, useaccessibilityRoleandaccessibilityStatesinstead ofaccessibilityTraitsandaccessibilityComponentType.
Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on. To use, set the accessibilityRole property to one of the following strings:
-Note: >
-accessibilityRoleandaccessibilityStatesare meant to be a cross-platform solution to replaceaccessibilityTraitsandaccessibilityComponentType, which will soon be deprecated. When possible, useaccessibilityRoleandaccessibilityStatesinstead ofaccessibilityTraitsandaccessibilityComponentType.
Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on. The state of the element can be set either to selected or disabled or both:
To use, set the accessibilityStates to an array containing either selected, disabled, or both.
--Note:
-accessibilityTraitswill soon be deprecated. When possible, useaccessibilityRoleandaccessibilityStatesinstead ofaccessibilityTraitsandaccessibilityComponentType.
Accessibility traits tell a person using VoiceOver what kind of element they have selected. Is this element a label? A button? A header? These questions are answered by accessibilityTraits.
To use, set the accessibilityTraits property to one of (or an array of) accessibility trait strings:
A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver.
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.
Assign this property to a custom function which will be called when someone performs the "magic tap" gesture, which is a double-tap with two fingers. A magic tap function should perform the most relevant action a user could take on a component. In the Phone app on iPhone, a magic tap answers a phone call, or ends the current one. If the selected element does not have an onMagicTap function, the system will traverse up the view hierarchy until it finds a view that does.
Assign this property to a custom function which will be called when someone performs the "escape" gesture, which is a two finger Z shaped gesture. An escape function should move back hierarchically in the user interface. This can mean moving up or back in a navigation hierarchy or dismissing a modal user interface. If the selected element does not have an onAccessibilityEscape function, the system will attempt to traverse up the view hierarchy until it finds a view that does or bonk to indicate it was unable to find one.
--Note: >
-accessibilityComponentTypewill soon be deprecated. When possible, useaccessibilityRoleandaccessibilityStatesinstead ofaccessibilityTraitsandaccessibilityComponentType.
In some cases, we also want to alert the end user of the type of selected component (i.e., that it is a “button”). If we were using native buttons, this would work automatically. Since we are using javascript, we need to provide a bit more context for TalkBack. To do so, you must specify the ‘accessibilityComponentType’ property for any UI component. We support 'none', ‘button’, ‘radiobutton_checked’ and ‘radiobutton_unchecked’.
-<TouchableWithoutFeedback accessibilityComponentType=”button”
- onPress={this._onPress}>
- <View style={styles.button}>
- <Text style={styles.buttonText}>Press me!</Text>
- </View>
-</TouchableWithoutFeedback>
-
-In the above example, the TouchableWithoutFeedback is being announced by TalkBack as a native Button.
When components dynamically change, we want TalkBack to alert the end user. This is made possible by the ‘accessibilityLiveRegion’ property. It can be set to ‘none’, ‘polite’ and ‘assertive’:
pointerEventsremoveClippedSubviewsstyletestIDaccessibilityComponentTypetestID <<<<<<< Updated upstreamaccessibilityComponentType+++++++++++++Stashed changes
+
accessibilityLiveRegioncollapsableimportantForAccessibilityneedsOffscreenAlphaCompositingrenderToHardwareTextureAndroidaccessibilityRoleaccessibilityStatesaccessibilityTraitsaccessibilityStates <<<<<<< Updated upstreamaccessibilityTraits+++++++++++++Stashed changes
+
accessibilityViewIsModalaccessibilityElementsHiddenaccessibilityIgnoresInvertColorsaccessibilityComponentType> Note: accessibilityComponentTypewill soon be deprecated. When possible, use accessibilityRole and accessibilityStates instead.
Indicates to accessibility services to treat UI component like a native one. Works for Android only.
-Possible values are one of:
-'none''button''radiobutton_checked''radiobutton_unchecked'| Type | Required | Platform |
|---|---|---|
| AccessibilityComponentTypes | No | Android |
accessibilityLiveRegionIndicates to accessibility services whether the user should be notified when this view changes. Works for Android API >= 19 only. Possible values:
accessibilityRole> Note: AccessibilityRole and AccessibilityStates are meant to be a cross-platform solution to replace accessibilityTraits and accessibilityComponentType, which will soon be deprecated. When possible, use accessibilityRole and accessibilityStates instead of accessibilityTraits and accessibilityComponentType.
Tells the screen reader to treat the currently focused on element as having a specific role.
Possible values for AccessibilityRole is one of:
accessibilityStates> Note: AccessibilityRole and AccessibilityStates are meant to be a cross-platform solution to replace accessibilityTraits and accessibilityComponentType, which will soon be deprecated. When possible, use accessibilityRole and accessibilityStates instead of accessibilityTraits and accessibilityComponentType.
Tells the screen reader to treat the currently focused on element as being in a specific state.
You can provide one state, no state, or both states. The states must be passed in through an array. Ex: ['selected'] or ['selected', 'disabled']
Possible values for AccessibilityStates are:
accessibilityTraits> Note: accessibilityTraits will soon be deprecated. When possible, use accessibilityRole and accessibilityStates instead.
Provides additional traits to screen reader. By default no traits are provided unless specified otherwise in element.
-You can provide one trait or an array of many traits.
-Possible values for AccessibilityTraits are:
'none' - The element has no traits.'button' - The element should be treated as a button.'link' - The element should be treated as a link.'header' - The element is a header that divides content into sections.'search' - The element should be treated as a search field.'image' - The element should be treated as an image.'selected' - The element is selected.'plays' - The element plays sound.'key' - The element should be treated like a keyboard key.'text' - The element should be treated as text.'summary' - The element provides app summary information.'disabled' - The element is disabled.'frequentUpdates' - The element frequently changes its value.'startsMedia' - The element starts a media session.'adjustable' - The element allows adjustment over a range of values.'allowsDirectInteraction' - The element allows direct touch interaction for VoiceOver users.'pageTurn' - Informs VoiceOver that it should scroll to the next page when it finishes reading the contents of the element.See the Accessibility guide for more information.
-| Type | Required | Platform |
|---|---|---|
| AccessibilityTraits, ,array of AccessibilityTraits | No | iOS |
accessibilityViewIsModalA value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. Default is false.
See the Accessibility guide for more information.
diff --git a/docs/next/view/index.html b/docs/next/view/index.html index 822ad465725..df8809d03ab 100644 --- a/docs/next/view/index.html +++ b/docs/next/view/index.html @@ -121,16 +121,46 @@pointerEventsremoveClippedSubviewsstyletestIDaccessibilityComponentTypetestID <<<<<<< Updated upstreamaccessibilityComponentType+++++++++++++Stashed changes
+
accessibilityLiveRegioncollapsableimportantForAccessibilityneedsOffscreenAlphaCompositingrenderToHardwareTextureAndroidaccessibilityRoleaccessibilityStatesaccessibilityTraitsaccessibilityStates <<<<<<< Updated upstreamaccessibilityTraits+++++++++++++Stashed changes
+
accessibilityViewIsModalaccessibilityElementsHiddenaccessibilityIgnoresInvertColorsaccessibilityComponentType> Note: accessibilityComponentTypewill soon be deprecated. When possible, use accessibilityRole and accessibilityStates instead.
Indicates to accessibility services to treat UI component like a native one. Works for Android only.
-Possible values are one of:
-'none''button''radiobutton_checked''radiobutton_unchecked'| Type | Required | Platform |
|---|---|---|
| AccessibilityComponentTypes | No | Android |
accessibilityLiveRegionIndicates to accessibility services whether the user should be notified when this view changes. Works for Android API >= 19 only. Possible values:
accessibilityRole> Note: AccessibilityRole and AccessibilityStates are meant to be a cross-platform solution to replace accessibilityTraits and accessibilityComponentType, which will soon be deprecated. When possible, use accessibilityRole and accessibilityStates instead of accessibilityTraits and accessibilityComponentType.
Tells the screen reader to treat the currently focused on element as having a specific role.
Possible values for AccessibilityRole is one of:
accessibilityStates> Note: AccessibilityRole and AccessibilityStates are meant to be a cross-platform solution to replace accessibilityTraits and accessibilityComponentType, which will soon be deprecated. When possible, use accessibilityRole and accessibilityStates instead of accessibilityTraits and accessibilityComponentType.
Tells the screen reader to treat the currently focused on element as being in a specific state.
You can provide one state, no state, or both states. The states must be passed in through an array. Ex: ['selected'] or ['selected', 'disabled']
Possible values for AccessibilityStates are:
accessibilityTraits> Note: accessibilityTraits will soon be deprecated. When possible, use accessibilityRole and accessibilityStates instead.
Provides additional traits to screen reader. By default no traits are provided unless specified otherwise in element.
-You can provide one trait or an array of many traits.
-Possible values for AccessibilityTraits are:
'none' - The element has no traits.'button' - The element should be treated as a button.'link' - The element should be treated as a link.'header' - The element is a header that divides content into sections.'search' - The element should be treated as a search field.'image' - The element should be treated as an image.'selected' - The element is selected.'plays' - The element plays sound.'key' - The element should be treated like a keyboard key.'text' - The element should be treated as text.'summary' - The element provides app summary information.'disabled' - The element is disabled.'frequentUpdates' - The element frequently changes its value.'startsMedia' - The element starts a media session.'adjustable' - The element allows adjustment over a range of values.'allowsDirectInteraction' - The element allows direct touch interaction for VoiceOver users.'pageTurn' - Informs VoiceOver that it should scroll to the next page when it finishes reading the contents of the element.See the Accessibility guide for more information.
-| Type | Required | Platform |
|---|---|---|
| AccessibilityTraits, ,array of AccessibilityTraits | No | iOS |
accessibilityViewIsModalA value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. Default is false.
See the Accessibility guide for more information.