Toggle: Improve screen-reader accessibility #1557
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull request checklist
Description of changes
The Toggle is currently not very accessible for screen-reader users as it doesn't have hooks that let us provide context on the option that's being toggled. This pull request adds two optional aria-labels that lets us provide more context on the on/off states for screen-reader users.
Video of screen-reader behavior after applying the pull-request.
It's not ideal that the screen-reader re-announces the toggle onText and offText, however, this is not easily preventable as many browser/screenreader combinations will announce aria-hidden children while reading the parent.
Focus areas to test