a11y: add aria-label to Sidebar nav - #101
Open
luke-ward88 wants to merge 1 commit into
Open
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
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.
Background
Screen reader users rely on
aria-label(oraria-labelledby) to distinguish between multiple<nav>landmarks on a page. The sidebar's<nav>infrontend/src/components/layout/Sidebar.tsxhad no label, so it was announced as a generic "navigation" region -- indistinguishable from any other nav on the page.Changes
Added
aria-labelto the sidebar's<nav>element, using the existingisChineseflag fromuseReviewLocaleto provide a localized label:Before
Screen reader announces: "navigation landmark" (no way to tell which nav).
After
Screen reader announces: "Main navigation landmark" (or "主导航" in Chinese).
Notes
isChineseflag is already destructured in the component, so no new hook calls needed.PublicLayout's header nav which already has anaria-label.