feat: Associate instruction text with input fields using aria-describ… #1700
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
…edby (#1640) This commit implements accessibility improvements by associating instructional text with their parent form fields using the aria-describedby attribute. Changes: - Modified ItemFieldGrid to recursively add aria-describedby to input/textarea elements and radio/checkbox groups when instructions are present - Added getInstructionsId helper function to generate instruction IDs - Updated DisplayInstructions component to accept an optional id prop - Added Storybook tests for String, Boolean, and Text items to verify aria-describedby functionality with instruction text Screen readers will now announce instructional text when a field receives focus, improving the accessibility experience for users with visual impairments. Fixes #1640
fongsean
suggested changes
Oct 24, 2025
Contributor
fongsean
left a comment
fongsean
left a comment
There was a problem hiding this comment.
I don't think this actually fixed the problem. I went into the stories and tried Voiceover - couldn't get the instructions to be read out.
Can you try using aria-describedby in the MUI components instead of getting React to create them dynamically?
Contributor
There was a problem hiding this comment.
Similar to #1699, can you add them under the testing folder instead? Something like title: 'Testing/Accessibility' is fine.
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.
…edby (#1640)
This commit implements accessibility improvements by associating instructional text with their parent form fields using the aria-describedby attribute.
Changes:
Screen readers will now announce instructional text when a field receives focus, improving the accessibility experience for users with visual impairments.
Fixes #1640