Skip to content

Commit 3b95661

Browse files
authored
fix(toast): Update a11y documentation (#4656)
1 parent 735b99c commit 3b95661

File tree

3 files changed

+16
-1
lines changed

3 files changed

+16
-1
lines changed

RELEASENOTES.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
<!-- Release notes authoring guidelines: http://keepachangelog.com/ -->
22
<!-- !!! THIS FILE IS AUTO-GENERATED !!! DO NOT EDIT THIS FILE MANUALLY !!! -->
33

4+
## Release 2.15.6 - May 5, 2021
5+
6+
## Components
7+
### [Toast](https://www.lightningdesignsystem.com/components/toast)
8+
#### Fixed
9+
- Corrected accessibility information regarding the usage of the `role` attribute.
10+
411
## Release 2.15.5 - April 29, 2021
512

613
## Release 2.15.4 - April 27, 2021

ui/components/toast/RELEASENOTES.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44

55
<!-- ## [Unreleased] -->
66

7+
## 2.15.6
8+
9+
### Fixed
10+
11+
- Corrected accessibility information regarding the usage of the `role` attribute.
12+
713
## 2.14.0
814

915
### Added

ui/components/toast/docs.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ import { getDisplayElementById } from '../../shared/helpers';
1717

1818
### Accessibility
1919

20-
Notifications should contain `role="status"` on the container to signal to assistive technology that they require the user’s attention. Historically the role of `alert` would be used, but because you can invoke multiple toasts, assertive alerts would override previous toasts in the screen reader's speech queue. Role of `status` is a polite live region, which does not clear the queue, reducing the risk of a toast message being missed.
20+
Toast should contain `role="alert"` on the container to signal to assistive technology that they require the user’s attention.
21+
22+
When the design uses multiple toasts simultaneously, set the role to `role="status"`. Historically, toasts would use the role of `alert`, but because you can invoke multiple toasts, assertive alerts would override previous toasts in the screen reader's speech queue. The role of `status` is a polite live region, which does not clear the queue, reducing the risk of a missed toast message.
2123

2224
Use a span with `slds-assistive-text` to let the user know what type of notification it is.
2325

0 commit comments

Comments
 (0)