feat: [a11y docs] DAYL-93 Input Checkbox a11y docn #4977
Conversation
ChrisLabattD2L
force-pushed
the
clabatt/a11y-docn-checkbox
branch
from
9dc90ab
to
dcdda37
Compare
|
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. |
components/inputs/input-checkbox.js
Outdated
There was a problem hiding this comment.
In addition to adding " for screen reader users" to the aria-label property, I'm wondering how we can clarify when to use aria-label vs the description property? There's no guidance on this, so we should either make it clear in the property descriptions or in a special note in the Accessibility section 🤔
There was a problem hiding this comment.
The more I think about it, the more I think what I wrote for aria-label is wrong, or at least the does not provide enough context part, since the providing more context is the responsibility of the description, not the label.
I'm thinking of changing it to: Use to override the text in the Default slot for screenreader users
What do you think?
There was a problem hiding this comment.
I'm not actually sure why we offer this. It might be helpful to find cases where it's used, to see if there are any clues as to why we introduced it?
Otherwise the "why" can just be left out, like you suggested. I would just start with "Overrides the text..." though for simplicity.
There was a problem hiding this comment.
I seem to recall us having this type of discussion in one of our meetings, I think the end result was we'd leave it in for now, but would talk with Gaudi about it to see if it was something that could just get removed, or changed to just being label
There was a problem hiding this comment.
I've updated it, but am going to leave this thread unresolved in case others wanted to weigh in on this topic
|
🎉 This PR is included in version 3.44.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
DAYL-93
This PR is updating the documentation for the
d2l-input-checkboxcomponent to denote the a11y aspects of the component. Adding theACCESSIBILITY:prefix in from of a11y properties and a small Accessibility section at the end.