Navigation block: Fix some off canvas appender accessibility issues #47047
Conversation
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
talldan
added
[Focus] Accessibility (a11y)
talldan
requested review from
MaggieCabrera,
alexstine,
carolinan,
draganescu,
getdave and
scruffian
|
Size Change: +142 B (0%) Total Size: 1.32 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in cc7e9ce. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/3890046761
|
getdave
reviewed
Jan 11, 2023
Comment on lines
+58
to
+65
| toggleProps={ { 'aria-describedby': descriptionId } } | ||
| /> | ||
| <div | ||
| className="offcanvas-editor-appender__description" | ||
| id={ descriptionId } | ||
| > | ||
| { description } | ||
| </div> |
getdave
reviewed
Jan 11, 2023
| } | ||
|
|
||
| .offcanvas-editor-appender__description { | ||
| display: none; |
Contributor
There was a problem hiding this comment.
Question: does not display: none make the content in accessible to screen readers entirely? I guess the purpose here is that we don't want this text to be read out except in the context of being the description of the inserter? Am I right?
Contributor
Author
There was a problem hiding this comment.
I think display: none is fine for aria descriptions. For visually hidden text where a different approach needs to be taken.
getdave
approved these changes
Jan 11, 2023
Contributor
getdave
left a comment
getdave
left a comment
There was a problem hiding this comment.
I tested this with Voiceover and it behaved as expected.
One small concern about the display: none but in my testing it did announce the description correctly so perhaps this isn't an Issue?
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.
What?
Fixes #47024
See also #47011
Sets the correct
aria-posinsetandaria-setsizehtml attributes for the off-canvas editor's appender.Also adds an aria description ('Append at position 3, Level 1') to give some context about where the block will be added.
Why?
The
aria-posinsetandaria-setsizeissue is very minor as screen readers don't announce them. But it's good to set it correctly just in case screenreaders do start announcing them after an update.The aria description is used to replace the fact that screen readers don't announce that information These descriptions could be improved to mention the parent block name (especially in the case of the appender). The trouble is there's no safe way to access the
rootClientIdat the moment. For now this is roughly inline with the other aria descriptions in List View.How?
Appenderimplementation to theListViewBranchcomponent (where it has access to the block count and nesting level).aria-posinsetandaria-setsize. Thearia-setsizefor blocks also needs to be incremented when there's an appender to account for the extra row.Testing Instructions for Keyboard
Screenshots or screencast