Improve a11y for TOC navigation #242
Draft
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
…age width on mobile Signed-off-by: Rito Rhymes <83614463+ritorhymes@users.noreply.github.com>
…ntent underneath it Signed-off-by: Rito Rhymes <83614463+ritorhymes@users.noreply.github.com>
Convert TOC wrapper to a semantic landmark with aria-label and a stable id for aria-controls. Keep nav button aria-expanded synced on open/close. Set aria-current='location' on the active ToC link and clear it from the previous active link. Close the ToC via Escape key when the nav toggle is visible. Signed-off-by: Rito Rhymes <83614463+ritorhymes@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Improves Table of Contents (ToC) navigation accessibility and keyboard behavior on mobile/tablet.
Changes
<nav>witharia-labeland a stableidforaria-controls.aria-expandedsynced with the open/closed state.aria-current="location"on the active ToC link and clear it from the previously active link.Dependency
It is stacked on PR #241 since ensuring the page layout works normally is foundational for other a11y enhancements to be effective.
Testing
A live demo is available at zaproxy-api.ritovision.com
aria-expandedupdates correctly, and Escape closes the ToC.aria-currentas expected while scrolling/clicking ToC links.<nav>landmark with the expected attributes.