Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 14 additions & 13 deletions docs/accessibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -250,31 +250,31 @@ Indicates an element is being modified and that assistive technologies may want

| Type | Default |
| ------- | ------- |
| boolean | false |
| 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 |
| 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 |
| boolean | `false` |

### `aria-expanded`

Indicates whether an expandable element is currently expanded or collapsed.

| Type | Default |
| ------- | ------- |
| boolean | false |
| boolean | `false` |

### `aria-hidden`

Expand All @@ -284,7 +284,7 @@ For example, in a window that contains sibling views `A` and `B`, setting `aria-

| Type | Default |
| ------- | ------- |
| boolean | false |
| boolean | `false` |

### `aria-label`

Expand Down Expand Up @@ -329,7 +329,7 @@ Boolean value indicating whether VoiceOver should ignore the elements within vie

| Type | Default |
| ------- | ------- |
| boolean | false |
| boolean | `false` |

### `aria-selected`

Expand Down Expand Up @@ -480,7 +480,7 @@ Assign this property to a custom function which will be called when someone perf
- **img** Used when the element should be treated as an image. Can be combined with a button or link, for example.
- **link** Used when the element should be treated as a link, specifically for interactive elements that open an external URL or web page in a browser. For in-app screen navigation or actions, use `button` instead.
- **list** Used to identify a list of items.
- **listitem** Used to itentify an item in a list.
- **listitem** Used to identify an item in a list.
- **menu** Used when the component is a menu of choices.
- **menubar** Used when a component is a container of multiple menus.
- **menuitem** Used to represent an item within a menu.
Expand Down Expand Up @@ -518,18 +518,19 @@ Actions either represent standard actions, such as clicking a button or adjustin

When adding support for standard actions, `name` must be one of the following:

- `'magicTap'` - iOS only - While VoiceOver focus is on or inside the component, the user double tapped with two fingers.
- `'escape'` - iOS only - While VoiceOver focus is on or inside the component, the user performed a two-finger scrub gesture (left, right, left).
- `'activate'` - Activate the component. This should perform the same action with, or without, assistive technology. Engaged when a screen reader user double taps the component.
- `'increment'` - Increment an adjustable component. On iOS, VoiceOver generates this action when the component has a role of `'adjustable'` and the user places focus on it and swipes upward. On Android, in TalkBack versions 8.1 and below, this action is generated when the user focuses the component and presses the volume-up button. In TalkBack 9.1 and later, this was replaced by the "Adjust Reading Control" gesture (swiping upward on the focused control).
- `'decrement'` - Decrement an adjustable component. On iOS, VoiceOver generates this action when the component has a role of `'adjustable'` and the user places focus on it and swipes downward. On Android, in TalkBack versions 8.2 and below, this action is generated when the user focuses the component and presses the volume-down button. In TalkBack 9.2 and later, this was replaced by the "Adjust Reading Control" gesture (swiping downward on the focused control).
- `'longpress'` - Android only - This action is generated when the user places accessibility focus on the component, then double-taps and holds one finger on the screen. This should perform the same action with, or without, assistive technology.
- `'expand'` - Android only - This action "expands" the component so that TalkBack will announce an "expanded" hint.
- `'collapse'` - Android only - This action "collapses" the component so that TalkBack will announce a "collapsed" hint.
- `'magicTap'` <div className="label ios">iOS</div> - While VoiceOver focus is on or inside the component, the user double tapped with two fingers.
- `'escape'` <div className="label ios">iOS</div> - While VoiceOver focus is on or inside the component, the user performed a two-finger scrub gesture (left, right, left).
- `'longpress'` <div className="label android">Android</div> - This action is generated when the user places accessibility focus on the component, then double-taps and holds one finger on the screen. This should perform the same action with, or without, assistive technology.
- `'expand'` <div className="label android">Android</div> - This action "expands" the component so that TalkBack will announce an "expanded" hint.
- `'collapse'` <div className="label android">Android</div> - This action "collapses" the component so that TalkBack will announce a "collapsed" hint.
- `'setProgress'` <div className="label android">Android</div> - Set an adjustable component to a specific value. When Android provides a value, the event passed to `onAccessibilityAction` includes it in `event.nativeEvent.value`.

The `label` field is optional for standard actions and is used by assistive technologies to describe the specific result of an action. For example, TalkBack uses this field to override the default "Double tap to activate" announcement with a custom description like "Double tap to open chat." For custom actions, the `label` is a localized string containing a description of the action to be presented to the user.

To handle action requests, a component must implement an `onAccessibilityAction` function. The only argument to this function is an event containing the name of the action to perform. The below example from RNTester shows how to create a component that defines and handles several custom actions.
To handle action requests, a component must implement an `onAccessibilityAction` function. The event includes the action name in `event.nativeEvent.actionName`. For the Android `setProgress` action, `event.nativeEvent.value` may also contain the requested numeric value.

```tsx
<View
Expand Down
11 changes: 11 additions & 0 deletions docs/accessibilityinfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ Add an event handler. Supported events:
| `reduceMotionChanged` | Fires when the state of the reduce motion toggle changes. The argument to the event handler is a boolean. The boolean is `true` when a reduce motion is enabled (or when "Transition Animation Scale" in "Developer options" is "Animation off") and `false` otherwise. |
| `reduceTransparencyChanged`<br/><div className="label two-lines ios">iOS</div> | Fires when the state of the reduce transparency toggle changes. The argument to the event handler is a boolean. The boolean is `true` when reduce transparency is enabled and `false` otherwise. |
| `screenReaderChanged` | Fires when the state of the screen reader changes. The argument to the event handler is a boolean. The boolean is `true` when a screen reader is enabled and `false` otherwise. |
| `showBordersChanged`<br/><div className="label two-lines ios">iOS</div> | Fires when the Show Borders setting changes (called Button Shapes before iOS 26.1). The event handler receives a boolean: `true` when enabled and `false` otherwise. |

---

Expand Down Expand Up @@ -227,6 +228,16 @@ Query whether a screen reader is currently enabled. Returns a promise which reso

---

### `isShowBordersEnabled()` <div className="label ios">iOS</div>

```tsx
static isShowBordersEnabled(): Promise<boolean>;
```

Query whether the Show Borders setting is enabled. This setting outlines tappable controls and was called Button Shapes before iOS 26.1. The promise resolves to `true` when enabled and `false` otherwise. On Android, the promise resolves to `false`.

---

### `isHighTextContrastEnabled()` <div className="label android">Android</div>

```tsx
Expand Down
2 changes: 1 addition & 1 deletion docs/button.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ See the [Accessibility guide](accessibility.md#accessibility-actions) for more i

### `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.
Invoked when the user performs an accessibility action. The event includes the action name. For the Android `setProgress` action, it may also include the requested numeric value.

See the [Accessibility guide](accessibility.md#accessibility-actions) for more information.

Expand Down
2 changes: 1 addition & 1 deletion docs/text.md
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@ See the [Accessibility guide](accessibility.md#accessibility-actions) for more i

### `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.
Invoked when the user performs an accessibility action. The event includes the action name. For the Android `setProgress` action, it may also include the requested numeric value.

See the [Accessibility guide](accessibility.md#accessibility-actions) for more information.

Expand Down
2 changes: 1 addition & 1 deletion docs/touchablewithoutfeedback.md
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ Indicates whether a selectable element is currently selected or not.

### `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.
Invoked when the user performs an accessibility action. The event includes the action name. For the Android `setProgress` action, it may also include the requested numeric value.

See the [Accessibility guide](accessibility.md#accessibility-actions) for more information.

Expand Down
2 changes: 1 addition & 1 deletion docs/view.md
Original file line number Diff line number Diff line change
Expand Up @@ -540,7 +540,7 @@ Designates the next view to receive focus when the user navigates up. See the [A

### `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.
Invoked when the user performs an accessibility action. The event includes the action name. For the Android `setProgress` action, it may also include the requested numeric value.

See the [Accessibility guide](accessibility.md#accessibility-actions) for more information.

Expand Down
Loading