fix: Improve form error feedback accessibility#1120
Closed
web3blind wants to merge 2 commits into
Closed
Conversation
Contributor
|
@web3blind is attempting to deploy a commit to the vetswhocode-web-app Team on Vercel. A member of the Team first needs to authorize it. |
jeromehardaway
requested review from
Copilot and
jeromehardaway
and removed request for
Copilot
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves accessibility of shared form elements by ensuring validation errors are programmatically associated with their corresponding inputs/textareas and announced by assistive technology.
Changes:
- Add
feedbackIdsupport and generate stable error-message IDs for form elements. - Mark error feedback as
role="alert"and wirearia-invalid/aria-describedbyonInputandTextarea. - Add unit tests validating the default error ID/linking behavior for
InputandTextarea.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
src/components/ui/form-elements/types.ts |
Adds a new feedbackId prop to shared input props to support stable error message IDs. |
src/components/ui/form-elements/input.tsx |
Sets aria-invalid/aria-describedby and assigns an ID to the rendered error feedback. |
src/components/ui/form-elements/textarea.tsx |
Mirrors Input accessibility wiring for textarea error feedback. |
src/components/ui/form-elements/feedback.tsx |
Adds optional id and announces error feedback via role="alert". |
src/components/ui/form-elements/__tests__/accessible-feedback.test.tsx |
Adds tests asserting default ${id}-error linkage and alert role behavior. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
12
to
18
| export interface IInputProps extends IFeedback { | ||
| className?: string; | ||
| disabled?: boolean; | ||
| readonly?: boolean; | ||
| feedbackText?: string; | ||
| feedbackId?: string; | ||
| id: string; |
Comment on lines
+5
to
+23
| describe("form element error feedback accessibility", () => { | ||
| it("connects input errors with aria-describedby and alert feedback", () => { | ||
| render( | ||
| <Input | ||
| id="email" | ||
| name="email" | ||
| state="error" | ||
| feedbackText="Enter a valid email address" | ||
| /> | ||
| ); | ||
|
|
||
| const input = screen.getByRole("textbox"); | ||
| const alert = screen.getByRole("alert"); | ||
|
|
||
| expect(input).toHaveAttribute("aria-invalid", "true"); | ||
| expect(input).toHaveAttribute("aria-describedby", "email-error"); | ||
| expect(alert).toHaveAttribute("id", "email-error"); | ||
| expect(alert).toHaveTextContent("Enter a valid email address"); | ||
| }); |
Author
|
Updated the PR to address the Copilot feedback around
Local validation:
Note: the Vercel status is still blocked by the existing Vercel team authorization gate, not by a build log from this change. |
Author
|
Withdrawing this stale accessibility PR as part of fork cleanup. Thanks for the consideration. |
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
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.
Summary
role="alert"so screen readers announce validation errors.aria-describedbyandaria-invalid.InputandTextareacomponents.Accessibility impact
This improves the shared form components used across application forms. When a field has validation feedback, assistive technology can now identify the field as invalid and read the matching error message.
Relates to #895.
Validation
npm test -- src/components/ui/form-elements/__tests__/accessible-feedback.test.tsx— passednpx biome check src/components/ui/form-elements/__tests__/accessible-feedback.test.tsx src/components/ui/form-elements/feedback.tsx src/components/ui/form-elements/input.tsx src/components/ui/form-elements/textarea.tsx src/components/ui/form-elements/types.ts— passed with existing complexity warnings ininput.tsxandtextarea.tsxnpm run typecheck— blocked by pre-existing unrelated test typing errors in__tests__/lib/j0di3and__tests__/pages/api/j0di3