Skip to content

Commit 74504f9

Browse files
feat: Add aria Web props to Accessibility docs
1 parent ea4f803 commit 74504f9

File tree

1 file changed

+83
-4
lines changed

1 file changed

+83
-4
lines changed

docs/accessibility.md

Lines changed: 83 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -220,15 +220,94 @@ Represents the current value for range-based components, such as sliders and pro
220220

221221
Repersents the textual description of the component.
222222

223+
### `aria-busy`
224+
225+
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.
226+
227+
| Type | Default |
228+
| ------- | ------- |
229+
| boolean | false |
230+
231+
### `aria-checked`
232+
233+
Indicates the state of a checkable element. This field can either take a boolean or the "mixed" string to represent mixed checkboxes.
234+
235+
| Type | Default |
236+
| ---------------- | ------- |
237+
| boolean, 'mixed' | false |
238+
239+
### `aria-disabled`
240+
241+
Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
242+
243+
| Type | Default |
244+
| ------- | ------- |
245+
| boolean | false |
246+
247+
### `aria-expanded`
248+
249+
Indicates whether an expandable element is currently expanded or collapsed.
250+
251+
| Type | Default |
252+
| ------- | ------- |
253+
| boolean | false |
254+
255+
### `aria-hidden`
256+
257+
Indicates whether the accessibility elements contained within this accessibility element are hidden.
258+
259+
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`.
260+
261+
| Type | Default |
262+
| ------- | ------- |
263+
| boolean | false |
264+
265+
### `aria-label`
266+
267+
Defines a string value that labels an interactive element.
268+
269+
| Type |
270+
| ------ |
271+
| string |
272+
273+
### `aria-labelledby` <div class="label android">Android</div>
274+
275+
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:
276+
277+
```jsx
278+
<View>
279+
<Text nativeID="formLabel">Label for Input Field</Text>
280+
<TextInput aria-label="input" aria-labelledby="formLabel" />
281+
</View>
282+
```
283+
284+
| Type |
285+
| ------ |
286+
| string |
287+
288+
### `aria-live` <div class="label android">Android</div>
289+
290+
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.
291+
292+
- **off** Accessibility services should not announce changes to this view.
293+
- **polite** Accessibility services should announce changes to this view.
294+
- **assertive** Accessibility services should interrupt ongoing speech to immediately announce changes to this view.
295+
223296
### `aria-modal` <div class="label ios">iOS</div>
224297

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

227-
| Type | Default |
228-
| ---- | ------- |
229-
| bool | false |
300+
| Type | Default |
301+
| ------- | ------- |
302+
| boolean | false |
230303

231-
---
304+
### `aria-selected`
305+
306+
Indicates whether a selectable element is currently selected or not.
307+
308+
| Type |
309+
| ------- |
310+
| boolean |
232311

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

0 commit comments

Comments
 (0)