Skip to content

Add documentation for sendAccessibilityEvent #4935

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Abbondanzo merged 5 commits into from
Dec 23, 2025
Merged

Add documentation for sendAccessibilityEvent #4935

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1eea7c7
Add documentation for sendAccessibilityEvent
Abbondanzo Dec 23, 2025
83f3bd3
Add windowStateChange to valid types
Abbondanzo Dec 23, 2025
24ce332
Fix formatting
Abbondanzo Dec 23, 2025
3d119ba
Improve examples for sendAccessibilityEvent
Abbondanzo Dec 23, 2025
9df23a2
Update old, versioned docs
Abbondanzo Dec 23, 2025
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
23 changes: 23 additions & 0 deletions docs/accessibilityinfo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,10 @@ Query whether reduce motion and prefer cross-fade transitions settings are curre

### `setAccessibilityFocus()`

:::warning Deprecated
Prefer using `sendAccessibilityEvent` with eventType `focus` instead.
:::

```tsx
static setAccessibilityFocus(reactTag: number);
```
Expand All @@ -247,3 +251,22 @@ On Android, this calls `UIManager.sendAccessibilityEvent` method with passed `re
:::note
Make sure that any `View` you want to receive the accessibility focus has `accessible={true}`.
:::

---

### `sendAccessibilityEvent()`

```tsx
static sendAccessibilityEvent(host: HostInstance, eventType: AccessibilityEventTypes);
```

Imperatively trigger an accessibility event on a React component, like changing the focused element for a screen reader.

:::note
Make sure that any `View` you want to receive the accessibility focus has `accessible={true}`.
:::

| Name | Type | Description |
| -------------------------------------------------------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| host <div className="label basic required">Required</div> | HostInstance | The component ref to send the event to. |
| eventType <div className="label basic required">Required</div> | AccessibilityEventTypes | One of `'click'` (Android only), `'focus'`, `'viewHoverEnter'` (Android only), or `'windowStateChange'` (Android only) |
27 changes: 26 additions & 1 deletion website/versioned_docs/version-0.77/accessibilityinfo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,10 @@ Query whether reduce motion and prefer cross-fade transitions settings are curre

### `setAccessibilityFocus()`

:::warning Deprecated
Prefer using `sendAccessibilityEvent` with eventType `focus` instead.
:::

```tsx
static setAccessibilityFocus(reactTag: number);
```
Expand All @@ -242,4 +246,25 @@ Set accessibility focus to a React component.

On Android, this calls `UIManager.sendAccessibilityEvent` method with passed `reactTag` and `UIManager.AccessibilityEventTypes.typeViewFocused` arguments.

> **Note**: Make sure that any `View` you want to receive the accessibility focus has `accessible={true}`.
:::note
Make sure that any `View` you want to receive the accessibility focus has `accessible={true}`.
:::

---

### `sendAccessibilityEvent()`

```tsx
static sendAccessibilityEvent(host: HostInstance, eventType: AccessibilityEventTypes);
```

Imperatively trigger an accessibility event on a React component, like changing the focused element for a screen reader.

:::note
Make sure that any `View` you want to receive the accessibility focus has `accessible={true}`.
:::

| Name | Type | Description |
| -------------------------------------------------------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| host <div className="label basic required">Required</div> | HostInstance | The component ref to send the event to. |
| eventType <div className="label basic required">Required</div> | AccessibilityEventTypes | One of `'click'` (Android only), `'focus'`, `'viewHoverEnter'` (Android only), or `'windowStateChange'` (Android only) |
27 changes: 26 additions & 1 deletion website/versioned_docs/version-0.78/accessibilityinfo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,10 @@ Query whether reduce motion and prefer cross-fade transitions settings are curre

### `setAccessibilityFocus()`

:::warning Deprecated
Prefer using `sendAccessibilityEvent` with eventType `focus` instead.
:::

```tsx
static setAccessibilityFocus(reactTag: number);
```
Expand All @@ -242,4 +246,25 @@ Set accessibility focus to a React component.

On Android, this calls `UIManager.sendAccessibilityEvent` method with passed `reactTag` and `UIManager.AccessibilityEventTypes.typeViewFocused` arguments.

> **Note**: Make sure that any `View` you want to receive the accessibility focus has `accessible={true}`.
:::note
Make sure that any `View` you want to receive the accessibility focus has `accessible={true}`.
:::

---

### `sendAccessibilityEvent()`

```tsx
static sendAccessibilityEvent(host: HostInstance, eventType: AccessibilityEventTypes);
```

Imperatively trigger an accessibility event on a React component, like changing the focused element for a screen reader.

:::note
Make sure that any `View` you want to receive the accessibility focus has `accessible={true}`.
:::

| Name | Type | Description |
| -------------------------------------------------------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| host <div className="label basic required">Required</div> | HostInstance | The component ref to send the event to. |
| eventType <div className="label basic required">Required</div> | AccessibilityEventTypes | One of `'click'` (Android only), `'focus'`, `'viewHoverEnter'` (Android only), or `'windowStateChange'` (Android only) |
27 changes: 26 additions & 1 deletion website/versioned_docs/version-0.79/accessibilityinfo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,10 @@ Query whether reduce motion and prefer cross-fade transitions settings are curre

### `setAccessibilityFocus()`

:::warning Deprecated
Prefer using `sendAccessibilityEvent` with eventType `focus` instead.
:::

```tsx
static setAccessibilityFocus(reactTag: number);
```
Expand All @@ -242,4 +246,25 @@ Set accessibility focus to a React component.

On Android, this calls `UIManager.sendAccessibilityEvent` method with passed `reactTag` and `UIManager.AccessibilityEventTypes.typeViewFocused` arguments.

> **Note**: Make sure that any `View` you want to receive the accessibility focus has `accessible={true}`.
:::note
Make sure that any `View` you want to receive the accessibility focus has `accessible={true}`.
:::

---

### `sendAccessibilityEvent()`

```tsx
static sendAccessibilityEvent(host: HostInstance, eventType: AccessibilityEventTypes);
```

Imperatively trigger an accessibility event on a React component, like changing the focused element for a screen reader.

:::note
Make sure that any `View` you want to receive the accessibility focus has `accessible={true}`.
:::

| Name | Type | Description |
| -------------------------------------------------------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| host <div className="label basic required">Required</div> | HostInstance | The component ref to send the event to. |
| eventType <div className="label basic required">Required</div> | AccessibilityEventTypes | One of `'click'` (Android only), `'focus'`, `'viewHoverEnter'` (Android only), or `'windowStateChange'` (Android only) |
27 changes: 26 additions & 1 deletion website/versioned_docs/version-0.80/accessibilityinfo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,10 @@ Query whether reduce motion and prefer cross-fade transitions settings are curre

### `setAccessibilityFocus()`

:::warning Deprecated
Prefer using `sendAccessibilityEvent` with eventType `focus` instead.
:::

```tsx
static setAccessibilityFocus(reactTag: number);
```
Expand All @@ -242,4 +246,25 @@ Set accessibility focus to a React component.

On Android, this calls `UIManager.sendAccessibilityEvent` method with passed `reactTag` and `UIManager.AccessibilityEventTypes.typeViewFocused` arguments.

> **Note**: Make sure that any `View` you want to receive the accessibility focus has `accessible={true}`.
:::note
Make sure that any `View` you want to receive the accessibility focus has `accessible={true}`.
:::

---

### `sendAccessibilityEvent()`

```tsx
static sendAccessibilityEvent(host: HostInstance, eventType: AccessibilityEventTypes);
```

Imperatively trigger an accessibility event on a React component, like changing the focused element for a screen reader.

:::note
Make sure that any `View` you want to receive the accessibility focus has `accessible={true}`.
:::

| Name | Type | Description |
| -------------------------------------------------------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| host <div className="label basic required">Required</div> | HostInstance | The component ref to send the event to. |
| eventType <div className="label basic required">Required</div> | AccessibilityEventTypes | One of `'click'` (Android only), `'focus'`, `'viewHoverEnter'` (Android only), or `'windowStateChange'` (Android only) |
27 changes: 26 additions & 1 deletion website/versioned_docs/version-0.81/accessibilityinfo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,10 @@ Query whether reduce motion and prefer cross-fade transitions settings are curre

### `setAccessibilityFocus()`

:::warning Deprecated
Prefer using `sendAccessibilityEvent` with eventType `focus` instead.
:::

```tsx
static setAccessibilityFocus(reactTag: number);
```
Expand All @@ -242,4 +246,25 @@ Set accessibility focus to a React component.

On Android, this calls `UIManager.sendAccessibilityEvent` method with passed `reactTag` and `UIManager.AccessibilityEventTypes.typeViewFocused` arguments.

> **Note**: Make sure that any `View` you want to receive the accessibility focus has `accessible={true}`.
:::note
Make sure that any `View` you want to receive the accessibility focus has `accessible={true}`.
:::

---

### `sendAccessibilityEvent()`

```tsx
static sendAccessibilityEvent(host: HostInstance, eventType: AccessibilityEventTypes);
```

Imperatively trigger an accessibility event on a React component, like changing the focused element for a screen reader.

:::note
Make sure that any `View` you want to receive the accessibility focus has `accessible={true}`.
:::

| Name | Type | Description |
| -------------------------------------------------------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| host <div className="label basic required">Required</div> | HostInstance | The component ref to send the event to. |
| eventType <div className="label basic required">Required</div> | AccessibilityEventTypes | One of `'click'` (Android only), `'focus'`, `'viewHoverEnter'` (Android only), or `'windowStateChange'` (Android only) |
23 changes: 23 additions & 0 deletions website/versioned_docs/version-0.82/accessibilityinfo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,10 @@ Query whether reduce motion and prefer cross-fade transitions settings are curre

### `setAccessibilityFocus()`

:::warning Deprecated
Prefer using `sendAccessibilityEvent` with eventType `focus` instead.
:::

```tsx
static setAccessibilityFocus(reactTag: number);
```
Expand All @@ -247,3 +251,22 @@ On Android, this calls `UIManager.sendAccessibilityEvent` method with passed `re
:::note
Make sure that any `View` you want to receive the accessibility focus has `accessible={true}`.
:::

---

### `sendAccessibilityEvent()`

```tsx
static sendAccessibilityEvent(host: HostInstance, eventType: AccessibilityEventTypes);
```

Imperatively trigger an accessibility event on a React component, like changing the focused element for a screen reader.

:::note
Make sure that any `View` you want to receive the accessibility focus has `accessible={true}`.
:::

| Name | Type | Description |
| -------------------------------------------------------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| host <div className="label basic required">Required</div> | HostInstance | The component ref to send the event to. |
| eventType <div className="label basic required">Required</div> | AccessibilityEventTypes | One of `'click'` (Android only), `'focus'`, `'viewHoverEnter'` (Android only), or `'windowStateChange'` (Android only) |
23 changes: 23 additions & 0 deletions website/versioned_docs/version-0.83/accessibilityinfo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,10 @@ Query whether reduce motion and prefer cross-fade transitions settings are curre

### `setAccessibilityFocus()`

:::warning Deprecated
Prefer using `sendAccessibilityEvent` with eventType `focus` instead.
:::

```tsx
static setAccessibilityFocus(reactTag: number);
```
Expand All @@ -247,3 +251,22 @@ On Android, this calls `UIManager.sendAccessibilityEvent` method with passed `re
:::note
Make sure that any `View` you want to receive the accessibility focus has `accessible={true}`.
:::

---

### `sendAccessibilityEvent()`

```tsx
static sendAccessibilityEvent(host: HostInstance, eventType: AccessibilityEventTypes);
```

Imperatively trigger an accessibility event on a React component, like changing the focused element for a screen reader.

:::note
Make sure that any `View` you want to receive the accessibility focus has `accessible={true}`.
:::

| Name | Type | Description |
| -------------------------------------------------------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| host <div className="label basic required">Required</div> | HostInstance | The component ref to send the event to. |
| eventType <div className="label basic required">Required</div> | AccessibilityEventTypes | One of `'click'` (Android only), `'focus'`, `'viewHoverEnter'` (Android only), or `'windowStateChange'` (Android only) |