-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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
Implement accessible version of Navigation overlay preview toggle control #53462
Implement accessible version of Navigation overlay preview toggle control #53462
Conversation
<div id={ overlayMenuPreviewId }> | ||
{ overlayMenuPreview && ( |
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.
Accessibility question. I couldn't find any definitive best practice for whether the element being targetted by aria-controls
should always remain in the DOM.
Currently the contents are added/removed by React on toggle. But should we instead leave it in the DOM and show/hide using CSS?
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.
I would think so. Here is an example that helps.
https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-controls
This uses the tab panel use-case where the tab content is hidden via CSS but not totally removed from the DOM.
Why is this panel being removed from the DOM anyway? Performance reasons?
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.
Just tested this and could not find any negative effects. No warnings in console after opening/closing.
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.
Why is this panel being removed from the DOM anyway? Performance reasons?
Generally it seems to be a common pattern in React. I believe it's because it's easier for the developer to simply not-render something based on state rather than figure out the best way to hide via CSS.
Sometimes I guess rendering a component when it's not needed might trigger performance issues so that's worth bearing in mind.
In this case however we should be ok to leave the items in the DOM.
Size Change: +1.3 kB (0%) Total Size: 1.5 MB
ℹ️ View Unchanged
|
Flaky tests detected in 949a3f2. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/5807469099
|
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.
Mostly ready. Thanks!
Co-authored-by: Alex Stine <alex.stine@yourtechadvisors.com>
What?
Make the Navigaiton block's overlay controls toggle perceivable to assistive tech.
Fixes #53461
Why?
Because otherwise a whole set of users cannot properly configure the block.
How?
aria-controls
to indicate which controls the button togglesaria-expanded
to button to indicate current state of control toggleTesting Instructions
Testing Instructions for Keyboard
Settings
tab.Display
panel within that section.Toggle overlay menu controls
.aria-expanded
is set tofalse
.aria-controls
attribute refers to an element with a valid DOMid
attribute.aria-expanded
update.aria-
updates accordingly.Screenshots or screencast
Screen.Capture.on.2023-08-09.at.10-36-12.mp4