Skip to content
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

Minor accessibility issues: lack of text labels and required roles #479

Open
Futyn-Maker opened this issue Jul 6, 2023 · 0 comments
Open
Labels
a11y enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@Futyn-Maker
Copy link

Hi! Thanks so much for this easy-to-use and functional documentation tool!

I have noticed several issues that may make it difficult for blind users of screen readers, such as NVDA for Windows or VoiceOver on iOS/macOS, to read the documentation.

  1. There are no text labels and aria-expanded attributes on the buttons for showing/hiding the table of contents and opening display options (in the header). It's necessary to add clear text labels (by using aria-label, for example), as well as the aria-expanded attribute, which should change its value depending on the state of the button.
  2. In the table of contents, the subsections that expand by click do not have the "button" role and are not focused using Tab. It is necessary to add to such elements (to the corresponding divs) role="button" and tabindex="0", or use the native tag <button>. It would also be great to add aria-expanded changing the value.
  3. It would also be great if the section that the user is currently reading would not only be highlighted in the table of contents, but also reported by the screen reader as the current one. To do this, add the attribute aria-current="true" to the section of the table of contents that is currently open.

I hope this can be implemented soon - it seems the fixes are very simple. Thanks again!

@3y3 3y3 added enhancement New feature or request good first issue Good for newcomers labels Jul 7, 2023
@3y3 3y3 added help wanted Extra attention is needed a11y labels Mar 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a11y enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
Status: No status
Development

No branches or pull requests

2 participants