Improve table of contents accessibility #205
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
kr8n3r
approved these changes
Feb 16, 2021
The table of contents fails WCAG 2.4.3. When the table of contents is expanded, a search field and a list of (sometimes) collapsible options appears. Focus is automatically set to the first link on the list, which means that screen reader users might miss both the search box and the "hide table of contents" button. The changes introduced in this PR ensure that focus is not set on the first nav option, but on the entire region. This way when the user navigates forward, they are able to encounter the search box and the "close" button. Additionally, adjust the markup for the open/close TOC buttons to use the <button> element instead of an anchor tag. The reason is that these elements both look and behave as buttons, not as links. This should aid assistive tech users in navigating this functionality (for ex using voice control)
danacotoran
force-pushed
the
toc-updates-for-a11y
branch
from
1f5f092 to
40ca253
Compare
3 tasks
This was referenced Mar 15, 2021
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.
The table of contents fails WCAG 2.4.3.
When the table of contents is expanded, a search field and a list of (sometimes) collapsible options appear. Focus is automatically set to the first link on the list, which means that screen reader users might miss both the search box and the "hide table of contents" button.
The changes introduced in this PR ensure that focus is not set on the first nav option, but on the entire region. This way when the user navigates forward, they are able to encounter the search box and the "close" button.
Additionally, adjust the markup for the open/close TOC buttons to use the
<button>element instead of an anchor tag. The reason is that these elements both look and behave as buttons, not as links. This should aid assistive tech users in navigating this functionality (for ex using voice control)Trello card: https://trello.com/c/vv0OR35g/630-march-update-tech-docs-template