-
Notifications
You must be signed in to change notification settings - Fork 67
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
docs(progress-bar-expressive): fix noisy status updates on docs page #2312
Conversation
🦋 Changeset detectedLatest commit: 0dc0357 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
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. One minor suggestion. It's better to add a note to docs on why we added aria-live="off"
so that it might be clear to someone reading these understand, why role=status
is not announcing the messages
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 overall
However I see some docs files were changed. Usually those should not be changed on docs updates. You might need to clean your node_modules and update from 17.4.0
99b2685
to
f313a32
Compare
Great suggestion, @saiponnada! I updated the docs and re-requested your review. :) |
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.
Perfect!
f313a32
to
0dc0357
Compare
@saiponnada @agliga, thanks for the re-review! Feel free to merge when ready. (I don't have merge access.) |
Fixes #2311
Description
The message elements with
role="status"
in the expressive progress bar doc examples are reading out constantly when perusing the Skin docs with a screen reader. This update setsaria-live="off"
on the rendered examples (but not on the rendered code snippets) so as not to be so disruptive when someone is reading the Skin docs.Notes
I opted to use
aria-live="off"
rather than removingrole="status"
, since we use the status role as a selector in themain.js
file. Setting an explicitaria-live="off"
overrides status's implicitaria-live="polite"
.Screenshots
N/A
Checklist