-
-
Notifications
You must be signed in to change notification settings - Fork 8.6k
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
fix(theme): improve a11y of DocSidebarItemCategory expand/collapsed button #9944
Merged
Conversation
This file contains 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
✅ [V2]Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
⚡️ Lighthouse report for the deploy preview of this PR
|
✅ [V2]Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
slorber
changed the title
fix(a11y): DocSidebarItemCategory expand/collapsed button
fix(theme): improve a11y of DocSidebarItemCategory expand/collapsed button
Mar 14, 2024
Thanks 👍 |
slorber
added
the
to backport
This PR is planned to be backported to a stable version of Docusaurus
label
Mar 14, 2024
OzakIOne
pushed a commit
that referenced
this pull request
Mar 15, 2024
This was referenced May 19, 2024
This was referenced May 26, 2024
This was referenced May 27, 2024
This was referenced Aug 21, 2024
This was referenced Aug 27, 2024
This was referenced Sep 4, 2024
This was referenced Sep 8, 2024
This was referenced Sep 11, 2024
This was referenced Sep 28, 2024
7 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
CLA Signed
Signed Facebook CLA
pr: bug fix
This PR fixes a bug in a past release.
to backport
This PR is planned to be backported to a stable version of Docusaurus
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.
Pre-flight checklist
Motivation
When using Narrator on Windows and using Tab to go over the items in the sidebar, it does not announce the expanded / collapsed state on link elements. This is because link elements should not be expandable, only buttons should be.
For expandable menu items with a preview page I moved the
aria-expanded
state to the actual button. For menu items without, I addedrole="button"
to the element.Test Plan
http://localhost:3000/docs/category/getting-started
Expected: Narrator announces the collapsed / expanded state.
Actual: Does not
Test links
Deploy preview: https://deploy-preview-9944--docusaurus-2.netlify.app/
Related issues/PRs
Relates microsoft/playwright.dev#1265
This came out of a discussion with @scottaohara, who is in the W3C WAI-ARIA working group.