feat: DAYL-96 Update Count Badge a11y docn #5077
Draft
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
|
Thanks for the PR! 🎉 We've deployed an automatic preview for this PR - you can see your changes here:
Note The build needs to finish before your changes are deployed. |
margaree
reviewed
Oct 16, 2024
Comment on lines
+76
to
+80
| - While non-interactable components traditionally shouldn't be focusable, the `tab-stop` property greatly helps screen-reader users find the the count badge | ||
| - Otherwise, screen-reader users would have to use the arrow keys to get to the badge, which can take considerably longer | ||
| - If the optional tooltip is used, then `tab-stop` isn't necessary, as the count-badge becomes focusable to render the tooltip | ||
| - The optional tooltip makes use of the [`d2l-toolip`](../../components/tooltip), which follows the [W3C best practices for Tooltips](https://www.w3.org/WAI/ARIA/apg/patterns/tooltip/) | ||
| - The use of this tooltip can help provide additional context such as providing the exact number, if it were to go above the limit set in `max-digits` |
There was a problem hiding this comment.
Just trying to make it a bit more clear, though probably needs @geurts input on wording
Suggested change
| - While non-interactable components traditionally shouldn't be focusable, the `tab-stop` property greatly helps screen-reader users find the the count badge | |
| - Otherwise, screen-reader users would have to use the arrow keys to get to the badge, which can take considerably longer | |
| - If the optional tooltip is used, then `tab-stop` isn't necessary, as the count-badge becomes focusable to render the tooltip | |
| - The optional tooltip makes use of the [`d2l-toolip`](../../components/tooltip), which follows the [W3C best practices for Tooltips](https://www.w3.org/WAI/ARIA/apg/patterns/tooltip/) | |
| - The use of this tooltip can help provide additional context such as providing the exact number, if it were to go above the limit set in `max-digits` | |
| Notable accessibility features: | |
| - `tab-stop`: | |
| - While non-interactable components traditionally shouldn't be focusable, this property greatly helps screen reader users find the the count badge, and removes the need to use the arrow keys to navigate to it. | |
| - If the optional tooltip is used, it isn't necessary, as the count-badge becomes focusable in order to display the tooltip | |
| - `has-tooltip`: | |
| - The optional tooltip makes use of the [`d2l-tooltip`](../../components/tooltip), which follows the [W3C best practices for Tooltips](https://www.w3.org/WAI/ARIA/apg/patterns/tooltip/) | |
| - This tooltip can help provide additional context, such as by providing the exact count badge number if it were to go above the limit set in `max-digits` |
There was a problem hiding this comment.
While I do like some of the changes, I'm not sure about the formatting, so I'd also likely to hear Jeff's input
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.
Context for DAYL-96: Count Badge > Improve a11y doc'n
The purpose of this PR is to update the a11y documentation for the
d2l-count-badgeandd2l-count-badge-iconcomponents. This primarily includes adding theACCESSIBILITY:prefix in front of accessibility-based components and adding a section at the end of the readme with some a11y considerations.I also had to update the properties tables in the readme, due to them being formatted differently than other readmes, so I've made them more consistent (the
defaultandrequiredfields are with the type now)