Minor accessibility issues: lack of text labels and required roles #479
Labels
a11y
enhancement
New feature or request
good first issue
Good for newcomers
help wanted
Extra attention is needed
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.
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 usingaria-label
, for example), as well as thearia-expanded
attribute, which should change its value depending on the state of the button.role="button"
andtabindex="0"
, or use the native tag<button>
. It would also be great to addaria-expanded
changing the value.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!
The text was updated successfully, but these errors were encountered: