From 9153ada3b01c8bfa3a7d217608dba61b15e60c45 Mon Sep 17 00:00:00 2001 From: supun_yasantha034 Date: Mon, 12 Oct 2026 11:56:12 +0530 Subject: [PATCH] docs: add priority option to announceForAccessibilityWithOptions (fixes #5258) --- docs/accessibilityinfo.md | 15 +++++++++------ .../version-0.84/accessibilityinfo.md | 15 +++++++++------ .../version-0.85/accessibilityinfo.md | 15 +++++++++------ .../version-0.86/accessibilityinfo.md | 15 +++++++++------ .../version-0.87/accessibilityinfo.md | 15 +++++++++------ 5 files changed, 45 insertions(+), 30 deletions(-) diff --git a/docs/accessibilityinfo.md b/docs/accessibilityinfo.md index b585efd6f6c..b0f475d99de 100644 --- a/docs/accessibilityinfo.md +++ b/docs/accessibilityinfo.md @@ -118,18 +118,21 @@ Post a string to be announced by the screen reader. ```tsx static announceForAccessibilityWithOptions( announcement: string, - options: {queue?: boolean}, + options: { + queue?: boolean; + priority?: 'low' | 'default' | 'high'; + }, ); ``` -Post a string to be announced by the screen reader with modification options. By default announcements will interrupt any existing speech, but on iOS they can be queued behind existing speech by setting `queue` to `true` in the options object. +Post a string to be announced by the screen reader with modification options. By default announcements will interrupt any existing speech, but on iOS they can be queued behind existing speech by setting `queue` to `true` in the options object. An optional `priority` can also be specified on iOS. **Parameters:** -| Name | Type | Description | -| ----------------------------------------------------------------- | ------ | -------------------------------------------------------------------------------------------- | -| announcement
Required
| string | The string to be announced | -| options
Required
| object | `queue` - queue the announcement behind existing speech
iOS
| +| Name | Type | Description | +| ----------------------------------------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| announcement
Required
| string | The string to be announced | +| options
Required
| object | Options object with the following keys: | --- diff --git a/website/versioned_docs/version-0.84/accessibilityinfo.md b/website/versioned_docs/version-0.84/accessibilityinfo.md index cfba1e6977e..e8fdea82388 100644 --- a/website/versioned_docs/version-0.84/accessibilityinfo.md +++ b/website/versioned_docs/version-0.84/accessibilityinfo.md @@ -118,18 +118,21 @@ Post a string to be announced by the screen reader. ```tsx static announceForAccessibilityWithOptions( announcement: string, - options: {queue?: boolean}, + options: { + queue?: boolean; + priority?: 'low' | 'default' | 'high'; + }, ); ``` -Post a string to be announced by the screen reader with modification options. By default announcements will interrupt any existing speech, but on iOS they can be queued behind existing speech by setting `queue` to `true` in the options object. +Post a string to be announced by the screen reader with modification options. By default announcements will interrupt any existing speech, but on iOS they can be queued behind existing speech by setting `queue` to `true` in the options object. An optional `priority` can also be specified on iOS. **Parameters:** -| Name | Type | Description | -| ----------------------------------------------------------------- | ------ | -------------------------------------------------------------------------------------------- | -| announcement
Required
| string | The string to be announced | -| options
Required
| object | `queue` - queue the announcement behind existing speech
iOS
| +| Name | Type | Description | +| ----------------------------------------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| announcement
Required
| string | The string to be announced | +| options
Required
| object | Options object with the following keys: | --- diff --git a/website/versioned_docs/version-0.85/accessibilityinfo.md b/website/versioned_docs/version-0.85/accessibilityinfo.md index cfba1e6977e..e8fdea82388 100644 --- a/website/versioned_docs/version-0.85/accessibilityinfo.md +++ b/website/versioned_docs/version-0.85/accessibilityinfo.md @@ -118,18 +118,21 @@ Post a string to be announced by the screen reader. ```tsx static announceForAccessibilityWithOptions( announcement: string, - options: {queue?: boolean}, + options: { + queue?: boolean; + priority?: 'low' | 'default' | 'high'; + }, ); ``` -Post a string to be announced by the screen reader with modification options. By default announcements will interrupt any existing speech, but on iOS they can be queued behind existing speech by setting `queue` to `true` in the options object. +Post a string to be announced by the screen reader with modification options. By default announcements will interrupt any existing speech, but on iOS they can be queued behind existing speech by setting `queue` to `true` in the options object. An optional `priority` can also be specified on iOS. **Parameters:** -| Name | Type | Description | -| ----------------------------------------------------------------- | ------ | -------------------------------------------------------------------------------------------- | -| announcement
Required
| string | The string to be announced | -| options
Required
| object | `queue` - queue the announcement behind existing speech
iOS
| +| Name | Type | Description | +| ----------------------------------------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| announcement
Required
| string | The string to be announced | +| options
Required
| object | Options object with the following keys: | --- diff --git a/website/versioned_docs/version-0.86/accessibilityinfo.md b/website/versioned_docs/version-0.86/accessibilityinfo.md index cfba1e6977e..e8fdea82388 100644 --- a/website/versioned_docs/version-0.86/accessibilityinfo.md +++ b/website/versioned_docs/version-0.86/accessibilityinfo.md @@ -118,18 +118,21 @@ Post a string to be announced by the screen reader. ```tsx static announceForAccessibilityWithOptions( announcement: string, - options: {queue?: boolean}, + options: { + queue?: boolean; + priority?: 'low' | 'default' | 'high'; + }, ); ``` -Post a string to be announced by the screen reader with modification options. By default announcements will interrupt any existing speech, but on iOS they can be queued behind existing speech by setting `queue` to `true` in the options object. +Post a string to be announced by the screen reader with modification options. By default announcements will interrupt any existing speech, but on iOS they can be queued behind existing speech by setting `queue` to `true` in the options object. An optional `priority` can also be specified on iOS. **Parameters:** -| Name | Type | Description | -| ----------------------------------------------------------------- | ------ | -------------------------------------------------------------------------------------------- | -| announcement
Required
| string | The string to be announced | -| options
Required
| object | `queue` - queue the announcement behind existing speech
iOS
| +| Name | Type | Description | +| ----------------------------------------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| announcement
Required
| string | The string to be announced | +| options
Required
| object | Options object with the following keys: | --- diff --git a/website/versioned_docs/version-0.87/accessibilityinfo.md b/website/versioned_docs/version-0.87/accessibilityinfo.md index b585efd6f6c..b0f475d99de 100644 --- a/website/versioned_docs/version-0.87/accessibilityinfo.md +++ b/website/versioned_docs/version-0.87/accessibilityinfo.md @@ -118,18 +118,21 @@ Post a string to be announced by the screen reader. ```tsx static announceForAccessibilityWithOptions( announcement: string, - options: {queue?: boolean}, + options: { + queue?: boolean; + priority?: 'low' | 'default' | 'high'; + }, ); ``` -Post a string to be announced by the screen reader with modification options. By default announcements will interrupt any existing speech, but on iOS they can be queued behind existing speech by setting `queue` to `true` in the options object. +Post a string to be announced by the screen reader with modification options. By default announcements will interrupt any existing speech, but on iOS they can be queued behind existing speech by setting `queue` to `true` in the options object. An optional `priority` can also be specified on iOS. **Parameters:** -| Name | Type | Description | -| ----------------------------------------------------------------- | ------ | -------------------------------------------------------------------------------------------- | -| announcement
Required
| string | The string to be announced | -| options
Required
| object | `queue` - queue the announcement behind existing speech
iOS
| +| Name | Type | Description | +| ----------------------------------------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| announcement
Required
| string | The string to be announced | +| options
Required
| object | Options object with the following keys: | ---