Improve accessibility (a11y) for screen-readers #70
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
This commit introduces the following changes for accessibility (a11y): - The Topbar is placed before the Main Content and the Sidebar. This is necessary for correct focus-order using tabbing or a screen-reader. - Many divs are replaced by semantic HTML tagnames. Specifically, the Sidebar is an <aside> element, the TableOfContents is a <nav> within the <aside>, the Main Content is a <main>, and the Topbar is a <header>. These landmarks help screen-readers identify these landmarks on the page. - The toggle buttons now have ARIA labels to help clarify their purpose. (Also, the sidebar-toggle button is now correctly hidden when the Sidebar is shown.) - The Sidebar's border is now not focusable (since it doesn't make sense to focus on it anyway).
Semantically, this indicates that the table of contents is structured as a nested list of items and sections.
seshrs
added
enhancement
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.
I did not have accessibility in mind when working on Primer Spec so far. For the v1.4 release, I'd like to include some improvements for students who use a screen-reader (or tab their way through the spec).
Visually, Primer Spec should look unchanged. However, this PR makes the following changes that affect screen-readers:
<div>elements with semantic HTML tagnames. Specifically, the Sidebar is contained in an<aside>element, the Table Of Contents is a<nav>within the<aside>, the Main Content is a<main>, and the Topbar is a<header>. These tags help screen-readers identify landmarks on the page.I verified these changes by learning to use my Mac's built-in screen-reader (VoiceOver). I also used the tab key without a screen-reader to verify a11y for keyboard-users.