Only use dialog on mobile #358
Merged
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
tombye
force-pushed
the
only-use-dialog-on-mobile
branch
from
1b9a255 to
55c36d4
Compare
tombye
force-pushed
the
only-use-dialog-on-mobile
branch
from
922901a to
b909310
Compare
tombye
force-pushed
the
only-use-dialog-on-mobile
branch
from
b909310 to
280ce40
Compare
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.
What’s changed
Changed the role of the table of contents so it's only a dialog on mobile-sized screens, to better match its behaviour.
A proposed fix for #357
The table of contents JS didn't have tests so I added some before making these changes.
Identifying a user need
Users need parts of the page to have roles that match their behaviour, otherwise it's confusing because it doesn't match their expectations. This is most obvious when you're using a screen reader and the tech docs are displayed on a desktop-size screen. The table of contents is announced as a dialog but it doesn't popup when you click a button like a dialog or have any of the other associated behaviours like tabbing being constrained to the dialog.
I chose to remove the role completely on desktop because its contents are already wrapped in landmark roles ('search' and 'navigation') and every landmark you add introduces more stuff to navigate.