-
-
Notifications
You must be signed in to change notification settings - Fork 9.8k
Accessibility: aria region around skiplink is superfluous #8418
Copy link
Copy link
Open
Labels
bugAn error in the Docusaurus core causing instability or issues with its executionAn error in the Docusaurus core causing instability or issues with its executiondomain: a11yRelated to accessibility concerns of the default themeRelated to accessibility concerns of the default themehelp wantedAsking for outside help and/or contributions to this particular issue or PR.Asking for outside help and/or contributions to this particular issue or PR.
Metadata
Metadata
Assignees
Labels
bugAn error in the Docusaurus core causing instability or issues with its executionAn error in the Docusaurus core causing instability or issues with its executiondomain: a11yRelated to accessibility concerns of the default themeRelated to accessibility concerns of the default themehelp wantedAsking for outside help and/or contributions to this particular issue or PR.Asking for outside help and/or contributions to this particular issue or PR.
Type
Fields
Give feedbackNo fields configured for issues without a type.
Have you read the Contributing Guidelines on issues?
Prerequisites
npm run clearoryarn clearcommand.rm -rf node_modules yarn.lock package-lock.jsonand re-installing packages.Description
In issue #6252, an aria region with the label "skip to main content" was placed around the "skip to main content" 'skiplink' which appears at the top of every docusaurus-generated page.
This was done in response to automated accessibility testing tools reporting that all page content should be contained in an aria region.
I agree that the skiplink should be contained in an aria region, but creating a dedicated aria region for the skiplink is a regression from a screen reader user's perspective.
Aria reagions are used to divide the page into multiple blocks of content in order to facilitate easy navigation between such blocks of content by screen reader users. Note that I say blocks, not single elements. If a page were cluttered with regions containing only one or two elements, the value of using aria live regions (i.e. the ability to quickly skip a lot of clutter and 'skim' the page on a high level) is quickly lost.
More importantly, superfluous regions (particularly those with long labels) contribute to information overload which is a major issue when working with a complex website using a screen reader. To understand the problem I'll quote my screen reader's speech output:
In summary: this region not only doubles the number of words I have to listen to, but also introduces a line break to my "view" of the page.
Long story short:
Reproducible demo
No response
Steps to reproduce
Use any docusaurus-generated page with a screen reader
Expected behavior
Skiplink is contained within the aria banner region
Actual behavior
Skiplink has a dedicated aria region, complicating navigation and causing screen readers to read a lot of superfluous information
Your environment
Self-service