Skip to content

[suggestion] making navigation bar clearer to screen reader users #1725

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kLiHz opened this issue Jan 10, 2022 · 1 comment
Open

[suggestion] making navigation bar clearer to screen reader users #1725

kLiHz opened this issue Jan 10, 2022 · 1 comment
Labels
A-accessibility Area: Accessibility a11y

Comments

@kLiHz
Copy link

kLiHz commented Jan 10, 2022

I once shared a mdBook site with a friend who is using screen readers, and we find that the screen reader must walk through all the TOC items before it reaches the Toggle Table of Contents button, as well as the page's main body.

From "Inspect Element" in the web browser, we can see that the Toggle Table of Contents button locates after the <nav> block.

The annoying thing is that this may happen each time a new visitor visits the site, especially when there are a lot of chapters in the TOC. After collapsing the side bar, the screen reader won't read the TOC anymore. Fortunately, once the user clicked the button, the sidebar may not automatically appear again in later tabs.

What I'm wondering is the necessity of making changes to the page's layout, since my friend told me that they can still locate the main text with some shortcuts provided by the screen reader.

Thanks!

@kLiHz
Copy link
Author

kLiHz commented Jan 24, 2022

After doing some research, I must appreciate the contribution by the authors of #535 and #611.

I found that through <main> tag, users can easily jump to the main part of the page. But to make things more clear, I think we can:

  • Add a "skipnav" link at the top of the nav bar.
  • Or add a title or something to tell the user that they are at the "Table of Contents".

Sorry for the trouble!

@kLiHz kLiHz changed the title Location of "Toggle Table of Contents" when using screen readers [suggestion] making navigation bar clearer to screen reader users Jan 24, 2022
@ehuss ehuss added the A-accessibility Area: Accessibility a11y label Jun 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-accessibility Area: Accessibility a11y
Projects
None yet
Development

No branches or pull requests

2 participants