-
Notifications
You must be signed in to change notification settings - Fork 1.1k
USWDS - Combobox: Remove added aria instructions (too verbose). #6022
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.
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
assistiveHintID
found 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.
Moved to FFR since it's small LOE and two peer reviews is enough for this level. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
I approved, but I'd like @amycole501 to give it one last look. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The revised combo box sounds much less wordy in both JAWS and NVDA. Much easier to listen to.
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:sass
to format any Sass updates.npm test
and confirm that all tests pass.