Make summary elements more accessible #530
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
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.
This PR fixes #504.
Checklist
Description
What's the goal of this PR?
To make the usage of
<summary>HTML element more accessible.What changes did you make?
There were two main impediments to accessibility in the current implementation:
<summary>elements that contain headings (i.e.<h1>through<h6>). This strips the headings of semantic meaning in some user setups. (This is the crux of Issue Summary elements shouldn't contain headings #504.)<summary>elements have custom open/close arrows, which alter semantic meaning and usability in some user setups.This PR fixes both of these by moving the headings outside of the
<summary>elements and going back to using the default open/close arrows. Notably, the default open/close arrows were already in use for the "Recommended Settings" sections (under Container info), so this change also makes things more consistent overall.What alternative solution should we consider, if any?
These changes are largely informed by "The details and summary elements, again" by Scott O'Hara, an accessibility specialist. The other suggestion there is to create fully custom open/close elements and not use
<details>and<summary>. This alternative should be considered as it could make things even more usable and accessible than what this PR achieves. It'd be a bigger change though, which is why I've opted here for a more incremental improvement to start with.