va-checkbox | Add description id to aria-describedby #817
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
13 tasks
jamigibbs
reviewed
Aug 28, 2023
| const ariaDescribedbyIds = [ | ||
| messageAriaDescribedby ? 'input-message' : '', | ||
| error ? 'checkbox-error-message' : '', | ||
| hasDescription ? 'description' : '', |
There was a problem hiding this comment.
Would there ever be a scenario when we wouldn't want the description content associated with aria-describedby?
There was a problem hiding this comment.
I think if no description is provided? We don't want to add IDs if they don't exist.
There was a problem hiding this comment.
Oh, I see what you're saying... Monday was really cray-cray for me. I can't think of any scenario like that. If it ever came up, we could modify the code to accommodate the need.
There was a problem hiding this comment.
yeah I think that's a fine strategy. I see the description slot being used in a couple of different places already though so just mentioning that here for awareness.
jamigibbs
approved these changes
Aug 29, 2023
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.
Chromatic
https://56080-checkbox-description--60f9b557105290003b387cd5.chromatic.com
Description
See #56080
Our Supplemental Claim form has a large amount of legal text (8 paragraphs plus a bullet list) which would not work because the
message-aria-describedbyonly accepts strings. So we moved the wall of content inside the description slot, but the screen reader still won't read out the content, so this PR adds adescriptionID to the input'saria-describedbyinside the shadow DOM. It was tested and the screen reader does read out the slotted content (see screenshot)Additionally, the
error-messageID on the span was changed tocheckbox-error-messageso that the USWDS and original checkbox code better matches. This doesn't look like it will make any tests in vets-website fail because React-Testing Library doesn't support shadow DOM and appears to only check the outererrorattribute, and looking through Cypress E2E tests reveals label checks more than anything else.Testing done
Updated tests to check
aria-describedbyIDsScreenshots
Acceptance criteria
Definition of done