Skip to content

docs: document priority option in announceForAccessibilityWithOptions #5273

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

Open
cpruijsen wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document priority option in announceForAccessibilityWithOptions #5273

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions docs/accessibilityinfo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,18 +118,18 @@ 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.

**Parameters:**

| Name | Type | Description |
| ----------------------------------------------------------------- | ------ | -------------------------------------------------------------------------------------------- |
| announcement <div className="label basic required">Required</div> | string | The string to be announced |
| options <div className="label basic required">Required</div> | object | `queue` - queue the announcement behind existing speech <div className="label ios">iOS</div> |
| Name | Type | Description |
| ----------------------------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| announcement <div className="label basic required">Required</div> | string | The string to be announced |
| options <div className="label basic required">Required</div> | object | `queue` - queue the announcement behind existing speech <div className="label ios">iOS</div><br/>`priority` - the priority of the announcement: `'low'`, `'default'` or `'high'` <div className="label ios">iOS</div><hr/>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. |

---

Expand Down
10 changes: 5 additions & 5 deletions website/versioned_docs/version-0.84/accessibilityinfo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,18 +118,18 @@ 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.

**Parameters:**

| Name | Type | Description |
| ----------------------------------------------------------------- | ------ | -------------------------------------------------------------------------------------------- |
| announcement <div className="label basic required">Required</div> | string | The string to be announced |
| options <div className="label basic required">Required</div> | object | `queue` - queue the announcement behind existing speech <div className="label ios">iOS</div> |
| Name | Type | Description |
| ----------------------------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| announcement <div className="label basic required">Required</div> | string | The string to be announced |
| options <div className="label basic required">Required</div> | object | `queue` - queue the announcement behind existing speech <div className="label ios">iOS</div><br/>`priority` - the priority of the announcement: `'low'`, `'default'` or `'high'` <div className="label ios">iOS</div><hr/>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. |

---

Expand Down
10 changes: 5 additions & 5 deletions website/versioned_docs/version-0.85/accessibilityinfo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,18 +118,18 @@ 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.

**Parameters:**

| Name | Type | Description |
| ----------------------------------------------------------------- | ------ | -------------------------------------------------------------------------------------------- |
| announcement <div className="label basic required">Required</div> | string | The string to be announced |
| options <div className="label basic required">Required</div> | object | `queue` - queue the announcement behind existing speech <div className="label ios">iOS</div> |
| Name | Type | Description |
| ----------------------------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| announcement <div className="label basic required">Required</div> | string | The string to be announced |
| options <div className="label basic required">Required</div> | object | `queue` - queue the announcement behind existing speech <div className="label ios">iOS</div><br/>`priority` - the priority of the announcement: `'low'`, `'default'` or `'high'` <div className="label ios">iOS</div><hr/>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. |

---

Expand Down
10 changes: 5 additions & 5 deletions website/versioned_docs/version-0.86/accessibilityinfo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,18 +118,18 @@ 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.

**Parameters:**

| Name | Type | Description |
| ----------------------------------------------------------------- | ------ | -------------------------------------------------------------------------------------------- |
| announcement <div className="label basic required">Required</div> | string | The string to be announced |
| options <div className="label basic required">Required</div> | object | `queue` - queue the announcement behind existing speech <div className="label ios">iOS</div> |
| Name | Type | Description |
| ----------------------------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| announcement <div className="label basic required">Required</div> | string | The string to be announced |
| options <div className="label basic required">Required</div> | object | `queue` - queue the announcement behind existing speech <div className="label ios">iOS</div><br/>`priority` - the priority of the announcement: `'low'`, `'default'` or `'high'` <div className="label ios">iOS</div><hr/>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. |

---

Expand Down
10 changes: 5 additions & 5 deletions website/versioned_docs/version-0.87/accessibilityinfo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,18 +118,18 @@ 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.

**Parameters:**

| Name | Type | Description |
| ----------------------------------------------------------------- | ------ | -------------------------------------------------------------------------------------------- |
| announcement <div className="label basic required">Required</div> | string | The string to be announced |
| options <div className="label basic required">Required</div> | object | `queue` - queue the announcement behind existing speech <div className="label ios">iOS</div> |
| Name | Type | Description |
| ----------------------------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| announcement <div className="label basic required">Required</div> | string | The string to be announced |
| options <div className="label basic required">Required</div> | object | `queue` - queue the announcement behind existing speech <div className="label ios">iOS</div><br/>`priority` - the priority of the announcement: `'low'`, `'default'` or `'high'` <div className="label ios">iOS</div><hr/>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. |

---

Expand Down
Loading