diff --git a/docs/accessibility.md b/docs/accessibility.md index de91a016c42..6dc7bab6374 100644 --- a/docs/accessibility.md +++ b/docs/accessibility.md @@ -293,6 +293,12 @@ Indicates that an element will be updated, and describes the types of updates th - **polite** Accessibility services should announce changes to this view. - **assertive** Accessibility services should interrupt ongoing speech to immediately announce changes to this view. +| Type | Default | +| ---------------------------------------- | ------- | +| enum(`'assertive'`, `'off'`, `'polite'`) | `'off'` | + +--- + ### `aria-modal`
iOS
Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. diff --git a/docs/text.md b/docs/text.md index 2fe4b519815..f461be822ea 100644 --- a/docs/text.md +++ b/docs/text.md @@ -376,6 +376,64 @@ Sets the frequency of automatic hyphenation to use when determining word breaks --- +### `aria-busy` + +Indicates an element is being modified and that assistive technologies may want to wait until the changes are complete before informing the user about the update. + +| Type | Default | +| ------- | ------- | +| boolean | false | + +--- + +### `aria-checked` + +Indicates the state of a checkable element. This field can either take a boolean or the "mixed" string to represent mixed checkboxes. + +| Type | Default | +| ---------------- | ------- | +| boolean, 'mixed' | false | + +--- + +### `aria-disabled` + +Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. + +| Type | Default | +| ------- | ------- | +| boolean | false | + +--- + +### `aria-expanded` + +Indicates whether an expandable element is currently expanded or collapsed. + +| Type | Default | +| ------- | ------- | +| boolean | false | + +--- + +### `aria-label` + +Defines a string value that labels an interactive element. + +| Type | +| ------ | +| string | + +--- + +### `aria-selected` + +Indicates whether a selectable element is currently selected or not. + +| Type | +| ------- | +| boolean | + ### `dataDetectorType`
Android
Determines the types of data converted to clickable URLs in the text element. By default, no data types are detected. diff --git a/docs/touchablewithoutfeedback.md b/docs/touchablewithoutfeedback.md index 9d021ed5bb2..ddfd036f4e1 100644 --- a/docs/touchablewithoutfeedback.md +++ b/docs/touchablewithoutfeedback.md @@ -195,6 +195,100 @@ See the [Accessibility guide](accessibility.md#accessibility-actions) for more i --- +### `aria-busy` + +Indicates an element is being modified and that assistive technologies may want to wait until the changes are complete before informing the user about the update. + +| Type | Default | +| ------- | ------- | +| boolean | false | + +--- + +### `aria-checked` + +Indicates the state of a checkable element. This field can either take a boolean or the "mixed" string to represent mixed checkboxes. + +| Type | Default | +| ---------------- | ------- | +| boolean, 'mixed' | false | + +--- + +### `aria-disabled` + +Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. + +| Type | Default | +| ------- | ------- | +| boolean | false | + +--- + +### `aria-expanded` + +Indicates whether an expandable element is currently expanded or collapsed. + +| Type | Default | +| ------- | ------- | +| boolean | false | + +--- + +### `aria-hidden` + +Indicates whether the accessibility elements contained within this accessibility element are hidden. + +For example, in a window that contains sibling views `A` and `B`, setting `aria-hidden` to `true` on view `B` causes VoiceOver to ignore the elements in the view `B`. + +| Type | Default | +| ------- | ------- | +| boolean | false | + +--- + +### `aria-label` + +Defines a string value that labels an interactive element. + +| Type | +| ------ | +| string | + +--- + +### `aria-live`
Android
+ +Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. + +- **off** Accessibility services should not announce changes to this view. +- **polite** Accessibility services should announce changes to this view. +- **assertive** Accessibility services should interrupt ongoing speech to immediately announce changes to this view. + +| Type | Default | +| ---------------------------------------- | ------- | +| enum(`'assertive'`, `'off'`, `'polite'`) | `'off'` | + +--- + +### `aria-modal`
iOS
+ +Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. Has precedence over the [`accessibilityViewIsModal`](#accessibilityviewismodal-ios) prop. + +| Type | Default | +| ------- | ------- | +| boolean | false | + +--- + +### `aria-selected` + +Indicates whether a selectable element is currently selected or not. + +| Type | +| ------- | +| boolean | + ### `onAccessibilityAction` Invoked when the user performs the accessibility actions. The only argument to this function is an event containing the name of the action to perform. diff --git a/docs/view.md b/docs/view.md index 977351cd910..3a744116246 100644 --- a/docs/view.md +++ b/docs/view.md @@ -249,6 +249,117 @@ When `true`, indicates that the view is an accessibility element. By default, al --- +### `aria-busy` + +Indicates an element is being modified and that assistive technologies may want to wait until the changes are complete before informing the user about the update. + +| Type | Default | +| ------- | ------- | +| boolean | false | + +--- + +### `aria-checked` + +Indicates the state of a checkable element. This field can either take a boolean or the "mixed" string to represent mixed checkboxes. + +| Type | Default | +| ---------------- | ------- | +| boolean, 'mixed' | false | + +--- + +### `aria-disabled` + +Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. + +| Type | Default | +| ------- | ------- | +| boolean | false | + +--- + +### `aria-expanded` + +Indicates whether an expandable element is currently expanded or collapsed. + +| Type | Default | +| ------- | ------- | +| boolean | false | + +--- + +### `aria-hidden` + +Indicates whether the accessibility elements contained within this accessibility element are hidden. + +For example, in a window that contains sibling views `A` and `B`, setting `aria-hidden` to `true` on view `B` causes VoiceOver to ignore the elements in the view `B`. + +| Type | Default | +| ------- | ------- | +| boolean | false | + +--- + +### `aria-label` + +Defines a string value that labels an interactive element. + +| Type | +| ------ | +| string | + +--- + +### `aria-labelledby`
Android
+ +Identifies the element that labels the element it is applied to. The value of `aria-labelledby` should match the [`nativeID`](view.md#nativeid) of the related element: + +```jsx + + Label for Input Field + + +``` + +| Type | +| ------ | +| string | + +--- + +### `aria-live`
Android
+ +Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. + +- **off** Accessibility services should not announce changes to this view. +- **polite** Accessibility services should announce changes to this view. +- **assertive** Accessibility services should interrupt ongoing speech to immediately announce changes to this view. + +| Type | Default | +| ---------------------------------------- | ------- | +| enum(`'assertive'`, `'off'`, `'polite'`) | `'off'` | + +--- + +### `aria-modal`
iOS
+ +Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. Has precedence over the [`accessibilityViewIsModal`](#accessibilityviewismodal-ios) prop. + +| Type | Default | +| ------- | ------- | +| boolean | false | + +--- + +### `aria-selected` + +Indicates whether a selectable element is currently selected or not. + +| Type | +| ------- | +| boolean | + ### `aria-valuemax` Represents the maximum value for range-based components, such as sliders and progress bars. Has precedence over the `max` value in the `accessibilityValue` prop. @@ -287,14 +398,6 @@ Represents the textual description of the component. Has precedence over the `te | ------ | | string | -### `aria-modal`
iOS
- -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`
Android