FormField -- include required text in screen reader only #6540
+55
−19
Conversation
This file contains hidden or 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
jcfilben
reviewed
Dec 15, 2022
ericsoderberghp
approved these changes
Dec 19, 2022
12 tasks
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 does this PR do?
This updates our approach to marking required fields with a required indicator. Previously, we relied on aria-label to put a "required" string on the * span. However, certain screen readers like JAWS/NVDA do not read aria-labels on spans. This takes an improved approach (mirroring an approach Bootstrap has taken) to include "required" in the DOM but keeping it only visible for screen readers.
This PR only addresses this behavior for themes that currently have
requiredIndicatorset to true. A subsequent PR will figure out how to handle for all cases.Where should the reviewer start?
What testing has been done on this PR?
Tested with VoiceOver and JAWS.
JAWS output
How should this be manually tested?
Do Jest tests follow these best practices?
screenis used for querying.userEventis used in place offireEvent.asFragment()is used for snapshot testing.Any background context you want to provide?
What are the relevant issues?
Relates to #6524
Screenshots (if appropriate)
Do the grommet docs need to be updated?
No.
Should this PR be mentioned in the release notes?
Yes. Improved screen reader support for required form fields.
Is this change backwards compatible or is it a breaking change?
Backwards compatible.