USWDS - Combobox: Remove added aria instructions (too verbose).#6022
Merged
Conversation
mejiaj
approved these changes
Aug 16, 2024
mejiaj
left a comment
Contributor
There was a problem hiding this comment.
Thanks @cathybaptista, LGTM. Minor comment on whether or not it's a breaking change, but not a blocker.
Please don't forget to create a changelog entry on the website (if there isn't one already).
mahoneycm
approved these changes
Aug 16, 2024
mahoneycm
left a comment
Contributor
There was a problem hiding this comment.
Looks good to me!
- SR-only assistive hint is no longer appended to DOM
- Screen reader callouts are appropriate and not overly verbose
- No additional references to the removed
assistiveHintIDfound in code - Components that extend combobox (such as time picker) also appropriately updated
I agree with @mejiaj that this doesn't qualify as a breaking change since the component markup is unaffected.
Contributor
|
Moved to FFR since it's small LOE and two peer reviews is enough for this level. |
3 tasks
Contributor
|
I approved, but I'd like @amycole501 to give it one last look. |
amycole501
approved these changes
Oct 3, 2024
amycole501
left a comment
There was a problem hiding this comment.
The revised combo box sounds much less wordy in both JAWS and NVDA. Much easier to listen to.
Merged
2 tasks
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Removed the arria instructions from combobox component. The combobox arria instructions are overly verbose and user testing reveals they are unnecessary. #5955
Breaking change
This is not a breaking change.
Related issue
Closes #5955
Related pull requests
Changelog uswds/uswds-site#2786
Preview link
Preview link:
Combobox with no arria instructions
Problem statement
Solution
Solution:
Why this approach was chosen: We considered adding instructions visible on the page that reflect the audible ARIA instructions. However, that would lengthen the page unnecessarily. We'd follow this guidance https://www.w3.org/WAI/WCAG21/Understanding/labels-or-instructions that suggests instructions be equally visible and audible (ie accessible to all users). In order to pass this SC, we recommend removing those additional keyboard instructions so the visible and audible instructions are more analogous.
Major changes
Removed lines L264-267 in packages/usa-combo-box/src/index.js:
Removed line 228
input.setAttribute("aria-describedby", assistiveHintID);Removed line 175
const assistiveHintID =${selectId}--assistiveHint;Testing and review
git pull origin [base branch]to pull in the most recent updates from your base and check for merge conflicts. (Often, the base branch isdevelop).npm run prettier:sassto format any Sass updates.npm testand confirm that all tests pass.