From c442f35a6389118995cf9b2d3d4ec0f2fefe2650 Mon Sep 17 00:00:00 2001 From: Christopher Pruijsen Date: Sat, 10 Oct 2026 00:02:27 +0100 Subject: [PATCH] docs: document priority option in announceForAccessibilityWithOptions --- docs/accessibilityinfo.md | 10 +++++----- .../versioned_docs/version-0.84/accessibilityinfo.md | 10 +++++----- .../versioned_docs/version-0.85/accessibilityinfo.md | 10 +++++----- .../versioned_docs/version-0.86/accessibilityinfo.md | 10 +++++----- .../versioned_docs/version-0.87/accessibilityinfo.md | 10 +++++----- 5 files changed, 25 insertions(+), 25 deletions(-) diff --git a/docs/accessibilityinfo.md b/docs/accessibilityinfo.md index b585efd6f6c..efa13b762fa 100644 --- a/docs/accessibilityinfo.md +++ b/docs/accessibilityinfo.md @@ -118,7 +118,7 @@ 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'}, ); ``` @@ -126,10 +126,10 @@ Post a string to be announced by the screen reader with modification options. By **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 | `queue` - queue the announcement behind existing speech
iOS

`priority` - the priority of the announcement: `'low'`, `'default'` or `'high'`
iOS

High priority announcements will interrupt any ongoing speech and cannot be interrupted. Default priority announcements will interrupt any ongoing speech but can be interrupted. Low priority announcements will not interrupt ongoing speech and can be interrupted. | --- diff --git a/website/versioned_docs/version-0.84/accessibilityinfo.md b/website/versioned_docs/version-0.84/accessibilityinfo.md index cfba1e6977e..61e3e036dbe 100644 --- a/website/versioned_docs/version-0.84/accessibilityinfo.md +++ b/website/versioned_docs/version-0.84/accessibilityinfo.md @@ -118,7 +118,7 @@ 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'}, ); ``` @@ -126,10 +126,10 @@ Post a string to be announced by the screen reader with modification options. By **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 | `queue` - queue the announcement behind existing speech
iOS

`priority` - the priority of the announcement: `'low'`, `'default'` or `'high'`
iOS

High priority announcements will interrupt any ongoing speech and cannot be interrupted. Default priority announcements will interrupt any ongoing speech but can be interrupted. Low priority announcements will not interrupt ongoing speech and can be interrupted. | --- diff --git a/website/versioned_docs/version-0.85/accessibilityinfo.md b/website/versioned_docs/version-0.85/accessibilityinfo.md index cfba1e6977e..61e3e036dbe 100644 --- a/website/versioned_docs/version-0.85/accessibilityinfo.md +++ b/website/versioned_docs/version-0.85/accessibilityinfo.md @@ -118,7 +118,7 @@ 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'}, ); ``` @@ -126,10 +126,10 @@ Post a string to be announced by the screen reader with modification options. By **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 | `queue` - queue the announcement behind existing speech
iOS

`priority` - the priority of the announcement: `'low'`, `'default'` or `'high'`
iOS

High priority announcements will interrupt any ongoing speech and cannot be interrupted. Default priority announcements will interrupt any ongoing speech but can be interrupted. Low priority announcements will not interrupt ongoing speech and can be interrupted. | --- diff --git a/website/versioned_docs/version-0.86/accessibilityinfo.md b/website/versioned_docs/version-0.86/accessibilityinfo.md index cfba1e6977e..61e3e036dbe 100644 --- a/website/versioned_docs/version-0.86/accessibilityinfo.md +++ b/website/versioned_docs/version-0.86/accessibilityinfo.md @@ -118,7 +118,7 @@ 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'}, ); ``` @@ -126,10 +126,10 @@ Post a string to be announced by the screen reader with modification options. By **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 | `queue` - queue the announcement behind existing speech
iOS

`priority` - the priority of the announcement: `'low'`, `'default'` or `'high'`
iOS

High priority announcements will interrupt any ongoing speech and cannot be interrupted. Default priority announcements will interrupt any ongoing speech but can be interrupted. Low priority announcements will not interrupt ongoing speech and can be interrupted. | --- diff --git a/website/versioned_docs/version-0.87/accessibilityinfo.md b/website/versioned_docs/version-0.87/accessibilityinfo.md index b585efd6f6c..efa13b762fa 100644 --- a/website/versioned_docs/version-0.87/accessibilityinfo.md +++ b/website/versioned_docs/version-0.87/accessibilityinfo.md @@ -118,7 +118,7 @@ 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'}, ); ``` @@ -126,10 +126,10 @@ Post a string to be announced by the screen reader with modification options. By **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 | `queue` - queue the announcement behind existing speech
iOS

`priority` - the priority of the announcement: `'low'`, `'default'` or `'high'`
iOS

High priority announcements will interrupt any ongoing speech and cannot be interrupted. Default priority announcements will interrupt any ongoing speech but can be interrupted. Low priority announcements will not interrupt ongoing speech and can be interrupted. | ---