Skip to content

Fix: Associate error message with form field for screen readers#82964

Merged
yuwenmemon merged 11 commits intoExpensify:mainfrom
marufsharifi:fix/screen-reader-error-message-field-association
Mar 15, 2026
Merged

Fix: Associate error message with form field for screen readers#82964
yuwenmemon merged 11 commits intoExpensify:mainfrom
marufsharifi:fix/screen-reader-error-message-field-association

Conversation

@marufsharifi
Copy link
Contributor

@marufsharifi marufsharifi commented Feb 19, 2026

Explanation of Change

When a field has an error, we now explicitly connect the visible error message to that input using accessibility attributes. As a result, screen readers can announce both that the field is invalid and what the error is when users focus the field.

Fixed Issues

$ #76939
PROPOSAL: #76939 (comment)

Tests

  1. Using JAWS + Chrome, open the web app
  2. Navigate using TAB to the phone or email input field.
  3. Trigger an error message, then press Tab/Shift+Tab key to focus the field with an error.
  4. Note how the field is announced.
  5. The error message is associated with the form control, so verify that it is announced upon focusing on the control.
  • Verify that no errors appear in the JS console

Offline tests

Same as Tests.

QA Steps

Same as Tests.

// TODO: These must be filled out, or the issue title must include "[No QA]."

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I verified there are no new alerts related to the canBeMissing param for useOnyx
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native
Screen.Recording.2026-02-24.at.8.51.07.PM.mov
Android: mWeb Chrome
Screen.Recording.2026-02-24.at.8.54.32.PM.mov
iOS: Native
Screen.Recording.2026-02-24.at.8.41.52.PM.mov
iOS: mWeb Safari
Screen.Recording.2026-02-24.at.8.44.59.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2026-02-23.at.7.02.36.PM.mp4

@melvin-bot
Copy link

melvin-bot bot commented Feb 19, 2026

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

@codecov
Copy link

codecov bot commented Feb 19, 2026

Codecov Report

✅ Changes either increased or maintained existing code coverage, great job!

Files with missing lines Coverage Δ
src/components/FormHelpMessage.tsx 85.71% <100.00%> (+0.52%) ⬆️
...s/TextInput/BaseTextInput/implementation/index.tsx 0.00% <0.00%> (ø)
... and 6 files with indirect coverage changes

@marufsharifi marufsharifi marked this pull request as ready for review February 24, 2026 16:31
@marufsharifi marufsharifi requested review from a team as code owners February 24, 2026 16:31
@melvin-bot melvin-bot bot requested review from suneox and removed request for a team February 24, 2026 16:31
@melvin-bot
Copy link

melvin-bot bot commented Feb 24, 2026

@suneox Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@melvin-bot melvin-bot bot requested review from joekaufmanexpensify and removed request for a team February 24, 2026 16:31
Copy link
Contributor

@joekaufmanexpensify joekaufmanexpensify left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good for product 👍

@marufsharifi
Copy link
Contributor Author

@suneox, kindly bump. thanks.

@marufsharifi
Copy link
Contributor Author

@suneox, quick bump. thanks.

@suneox
Copy link
Contributor

suneox commented Mar 2, 2026

@suneox, quick bump. thanks.

Sure I'll take a look at this one today

@suneox
Copy link
Contributor

suneox commented Mar 2, 2026

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified proper code patterns were followed (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: HybridApp
CleanShot.2026-03-11.at.21.16.27.2.mp4
CleanShot.2026-03-15.at.22.54.53.3.mp4
Android: mWeb Chrome
CleanShot.2026-03-11.at.21.18.32.3.mp4
CleanShot.2026-03-15.at.23.07.47.4.mp4
iOS: HybridApp
CleanShot.2026-03-11.at.20.56.23.1.mp4
CleanShot.2026-03-15.at.22.41.45.1.mp4
iOS: mWeb Safari
ScreenRecording_03-11-2026.21-30-08_1.1.mp4
MacOS: Chrome / Safari
CleanShot.2026-03-11.at.21.02.13.1.mp4
CleanShot.2026-03-15.at.22.42.53.2.mp4

@marufsharifi
Copy link
Contributor Author

@suneox, I've addressed your comments. Please take another look when you get a chance. thanks.

@marufsharifi
Copy link
Contributor Author

@suneox, kindly bump. thanks.

@marufsharifi
Copy link
Contributor Author

@suneox, quick bump. thanks.

@suneox
Copy link
Contributor

suneox commented Mar 11, 2026

@suneox, quick bump. thanks.

I’m starting to take a look at this one.

@marufsharifi
Copy link
Contributor Author

@suneox I’ve updated the fix for Safari and re-tested it on the other platforms as well. It is now working as expected across all tested platforms.

Video demo:

error-announcemnt-safari.mov

@suneox
Copy link
Contributor

suneox commented Mar 13, 2026

@suneox I’ve updated the fix for Safari and re-tested it on the other platforms as well. It is now working as expected across all tested platforms.

Video demo:

error-announcemnt-safari.mov

Great, I’ll take a look at this shortly.

Comment on lines +38 to +39
/** Native ID applied to the message text when a direct text association is needed */
messageNativeID?: string;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you got any reference we need to rename this prop?

// This is workaround for https://github.com/Expensify/App/issues/47939: in case when user is using Chrome on Android we set inputMode to 'search' to disable autocomplete bar above the keyboard.
// If we need some other inputMode (eg. 'decimal'), then the autocomplete bar will show, but we can do nothing about it as it's a known Chrome bug.
const inputMode = inputProps.inputMode ?? (isMobileChrome() ? 'search' : undefined);
const accessibilityLabel = [label, hint, errorText ? translate('common.yourReviewIsRequired') : ''].filter(Boolean).join(', ');
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this intended to remove the common.yourReviewIsRequired message?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did not restore the generic phrase because the final fix uses the actual error text on web, while native error announcement remains unchanged through the native implementation.

@suneox
Copy link
Contributor

suneox commented Mar 14, 2026

@codex review new update

@suneox
Copy link
Contributor

suneox commented Mar 14, 2026

@marufsharifi The live error message functionality is broken after the new update.

CleanShot.2026-03-14.at.15.29.02.1.mp4

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: ca42220e83

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

const accessibilityLabel = [label, hint, errorText ? translate('common.yourReviewIsRequired') : ''].filter(Boolean).join(', ');
const inputNativeID = inputProps.nativeID ?? inputProps.id ?? inputID ?? `text-input-${helpMessageId}`;
const helpMessageTextID = `${helpMessageId}-text`;
const accessibilityLabel = inputProps.accessibilityLabel ?? [label, hint].filter(Boolean).join(', ');

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Restore invalid cue in default accessibilityLabel

Removing translate('common.yourReviewIsRequired') from the default accessibilityLabel regresses native screen-reader behavior when a field has errorText: on iOS/Android, the new aria-errormessage/aria-invalid attributes are not what gets announced, so refocusing an invalid input no longer conveys that it is in an error state (previously it always did via the label). This especially affects repeated navigation back to the same field after validation errors.

Useful? React with 👍 / 👎.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the PR change is in the web implementation and native still has its own path

@suneox
Copy link
Contributor

suneox commented Mar 14, 2026

@marufsharifi Please review the comments above and including this one.

@marufsharifi
Copy link
Contributor Author

@suneox I’ve updated the fix based on the latest comments and re-tested it across the affected platforms.

Current result:

  • Safari + VoiceOver: the error is announced when it appears and also when the invalid input is focused again
  • Other tested platforms/browsers: still working as expected, with no regression observed in my testing

Please take another look when you have a chance.

safari-error-announcement.mov

@marufsharifi
Copy link
Contributor Author

@suneox could you please re-review when you have a chance?

@suneox
Copy link
Contributor

suneox commented Mar 15, 2026

@suneox I’ve updated the fix based on the latest comments and re-tested it across the affected platforms.

@marufsharifi How about your validation on the native platform? Is the error message associated when the input is focused?

CleanShot.2026-03-15.at.18.07.11.1.mp4

@marufsharifi
Copy link
Contributor Author

@suneox yes, on native the error is associated and announced when the screen-reader focus moves back to the input.

For this case, the relevant validation is VoiceOver focus, not just tapping/clicking the field. On the simulator, please move the VoiceOver focus to the input using Control + Option + Left/Right Arrow as shown in the simulator header. When the input receives VoiceOver focus that way, the associated error message is read as expected.

@marufsharifi
Copy link
Contributor Author

@suneox video demo of test on iOS native

Screen.Recording.2026-03-15.at.4.17.09.PM.mov

@suneox
Copy link
Contributor

suneox commented Mar 15, 2026

@suneox yes, on native the error is associated and announced when the screen-reader focus moves back to the input.

For this case, the relevant validation is VoiceOver focus, not just tapping/clicking the field. On the simulator, please move the VoiceOver focus to the input using Control + Option + Left/Right Arrow as shown in the simulator header. When the input receives VoiceOver focus that way, the associated error message is read as expected.

It work for me, I've updated screenshot

@melvin-bot
Copy link

melvin-bot bot commented Mar 15, 2026

We did not find an internal engineer to review this PR, trying to assign a random engineer to #76939 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

@melvin-bot melvin-bot bot requested a review from yuwenmemon March 15, 2026 16:31
@yuwenmemon yuwenmemon merged commit 0a415ed into Expensify:main Mar 15, 2026
34 checks passed
@github-actions
Copy link
Contributor

🚧 @yuwenmemon has triggered a test Expensify/App build. You can view the workflow run here.

@OSBotify
Copy link
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/yuwenmemon in version: 9.3.38-0 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/cristipaval in version: 9.3.38-4 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants