Skip to content

Accessibility: Announce empty results state to screen readers#83801

Merged
yuwenmemon merged 9 commits intoExpensify:mainfrom
marufsharifi:a11y/announce-empty-search-state
Mar 12, 2026
Merged

Accessibility: Announce empty results state to screen readers#83801
yuwenmemon merged 9 commits intoExpensify:mainfrom
marufsharifi:a11y/announce-empty-search-state

Conversation

@marufsharifi
Copy link
Contributor

@marufsharifi marufsharifi commented Mar 1, 2026

Explanation of Change

When a user searches and there are no matches, the "No results found" message is now reliably announced to screen reader users, but only when that message is actually visible.

Note: This PR only covers native platforms (iOS native and Android native). The web platform fix (mWeb, desktop web) will be handled separately in #83126.

Fixed Issues

$ #77422
PROPOSAL: #77422 (comment)

Tests

  1. Using VoiceOver on iOS or TalkBack on Android, open the app (native only)
  2. Swipe to focus the Create tab and double-tap to activate it
  3. Swipe to focus the Start chat button and double-tap to activate it
  4. Swipe to focus the text field and type in any search query that yields no results.
  5. Verify the status message 'No results found' is announced once it is displayed.
  • Verify that no errors appear in the JS console

Offline tests

Same as Tests.

QA Steps

Same as Tests (native platforms only — iOS native and Android native).

// 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:
  • 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 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-03-02.at.12.58.31.PM.mov
Android: mWeb Chrome
Screen.Recording.2026-03-01.at.11.27.19.AM.mov
iOS: Native
Screen.Recording.2026-03-01.at.11.17.06.AM.mov
iOS: mWeb Safari
Screen.Recording.2026-03-04.at.3.39.39.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2026-03-04.at.3.34.41.PM.mov

@codecov
Copy link

codecov bot commented Mar 4, 2026

Codecov Report

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

Files with missing lines Coverage Δ
src/components/FormHelpMessage.tsx 85.18% <ø> (ø)
.../components/SelectionList/components/TextInput.tsx 100.00% <100.00%> (ø)
...ListWithSections/BaseSelectionListWithSections.tsx 74.37% <100.00%> (+0.23%) ⬆️
...rc/hooks/useAccessibilityAnnouncement/index.ios.ts 100.00% <100.00%> (ø)
src/hooks/useAccessibilityAnnouncement/index.ts 0.00% <0.00%> (ø)
...hooks/useAccessibilityAnnouncement/index.native.ts 0.00% <0.00%> (ø)
... and 10 files with indirect coverage changes

@marufsharifi marufsharifi marked this pull request as ready for review March 4, 2026 11:30
@marufsharifi marufsharifi requested review from a team as code owners March 4, 2026 11:30
@melvin-bot melvin-bot bot requested review from JmillsExpensify and suneox and removed request for a team March 4, 2026 11:30
@melvin-bot
Copy link

melvin-bot bot commented Mar 4, 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]

JmillsExpensify
JmillsExpensify previously approved these changes Mar 4, 2026
Copy link
Contributor

@JmillsExpensify JmillsExpensify left a comment

Choose a reason for hiding this comment

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

LGTM

@suneox
Copy link
Contributor

suneox commented Mar 7, 2026

@marufsharifi We need to resolve this issue first before move forward with this PR since we can reuse existing functionality

@marufsharifi
Copy link
Contributor Author

marufsharifi commented Mar 7, 2026

@suneox, I've addressed all your comments. Please take another look. thanks.

@marufsharifi
Copy link
Contributor Author

@suneox, kindly bump. thanks.

@suneox
Copy link
Contributor

suneox commented Mar 9, 2026

@suneox, kindly bump. thanks.

Sure I'll take another look at this one soon

@suneox
Copy link
Contributor

suneox commented Mar 9, 2026

@marufsharifi The functionality doesn't work on mWeb/IOS and android native, and don't forget reverify other place

Wallet: Add Bank Account
Create Workspace > Company Cards: Add Card

android native
az_recorder_20260309_202715.2.mp4
mWeb/IOS
ScreenRecording_03-09-2026.20-20-34_1.3.mp4

@marufsharifi
Copy link
Contributor Author

@suneox

I re-tested this after the latest update.

Current scope of this PR:

  • Fixed on iOS native
  • Fixed on Android native

This PR is no longer intended to cover mWeb / Mac web. The web-side fix will be handled in #83126:

Attached:

  1. iOS native repro/fix video
Screen.Recording.2026-03-10.at.2.55.24.PM.mov
  1. Android native repro/fix video
Screen.Recording.2026-03-10.at.2.49.31.PM.mov

@marufsharifi
Copy link
Contributor Author

marufsharifi commented Mar 10, 2026

@suneox, lint failure is not related to our changes, btw.

@suneox
Copy link
Contributor

suneox commented Mar 11, 2026

This PR is no longer intended to cover mWeb / Mac web. The web-side fix will be handled in #83126:

I'm agree as suggested resolution in the OP include No mobile browser

Apple iPhone 14 Pro - iOS 18.7.1, Wi-Fi - Native (No mobile browser)
Samsung Galaxy Note10 Plus - Android 12, H0T Mobile - Native (No mobile browser)

cc: @rushatgabhane

@suneox
Copy link
Contributor

suneox commented Mar 11, 2026

@marufsharifi Issue fixed on Android, but still not announced on iOS.

CleanShot.2026-03-11.at.22.11.51.2.mp4
Android
CleanShot.2026-03-11.at.22.09.44.1.mp4

@rushatgabhane
Copy link
Member

I'm agree as suggested resolution in the #77422 (comment) include No mobile browser

Yeah that sounds good to me

@rushatgabhane
Copy link
Member

rushatgabhane commented Mar 11, 2026

@marufsharifi @suneox to fix the iOS issue maybe we can try AccessibilityInfo.announceForAccessibilityWithOptions(message, { queue: true });

https://reactnative.dev/docs/accessibilityinfo#announceforaccessibilitywithoptions

@marufsharifi
Copy link
Contributor Author

@suneox thanks for the review, I re-tested this based on the expected behavior described in the issue, using VoiceOver for screen reader validation, and it appears to be working as expected on iOS native.

I enabled Mac's VoiceOver and verified that when No results found is shown, it is announced as expected on iOS native.

Since this issue is specifically about screen reader announcement behavior, I think VoiceOver may be the more relevant validation signal here than Accessibility Inspector alone.

Video demo of the fix on IOS native:

no-result-announced-ios-native.mov

@suneox
Copy link
Contributor

suneox commented Mar 12, 2026

@muttmuure I'd like to confirm it work on real device, and simulator with voice over

ScreenRecording_03-12-2026.21-51-39_1.1.mp4
Simulator Voice Over
CleanShot.2026-03-12.at.21.47.34.1.mp4

@suneox
Copy link
Contributor

suneox commented Mar 12, 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
561682985-1e3ef379-1a5d-445a-9e4f-48ba8c45b152.mp4
CleanShot.2026-03-12.at.21.47.34.1.mp4
Android: mWeb Chrome

Not available

iOS: HybridApp
ScreenRecording_03-12-2026.21-51-39_1.1.mp4
iOS: mWeb Safari

Not available

MacOS: Chrome / Safari

Not available

@suneox
Copy link
Contributor

suneox commented Mar 12, 2026

@marufsharifi As confirmed, this PR only handles the native platform. Could you please update the PR description accordingly?

@melvin-bot melvin-bot bot requested a review from yuwenmemon March 12, 2026 15:08
@rushatgabhane
Copy link
Member

@MelvinBot update the PR desc - #83801 (comment)

@rushatgabhane
Copy link
Member

@yuwenmemon all yours 🙇

@melvin-bot
Copy link

melvin-bot bot commented Mar 12, 2026

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

@MelvinBot
Copy link
Contributor

Updated the PR description to reflect that this PR only covers native platforms (iOS native and Android native). Changes made:

  1. Explanation of Change — Added a note clarifying native-only scope and linking to Fix: "No results" status message not announced by screen readers #83126 for the web platform fix.
  2. Tests — Added "(native only)" clarification to step 1.
  3. QA Steps — Added "(native platforms only — iOS native and Android native)" clarification.
  4. Platform testing checklist — Unchecked Android mWeb, iOS mWeb, and MacOS with "N/A" notes linking to the web fix PR.

@yuwenmemon yuwenmemon merged commit b836663 into Expensify:main Mar 12, 2026
40 of 44 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.37-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.37-10 🚀

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