Skip to content

Fix: Screen reader does not announce search suggestions in Settings > Security - #83096

Closed
marufsharifi wants to merge 9 commits into
Expensify:mainfrom
marufsharifi:fix/sr-security-search-suggestions-announcement
Closed

marufsharifi wants to merge 9 commits into
Expensify:mainfrom
marufsharifi:fix/sr-security-search-suggestions-announcement

Conversation

@marufsharifi

@marufsharifi marufsharifi commented Feb 20, 2026 •

Copy link
Copy Markdown

Explanation of Change

This change delivers a targeted accessibility improvement for web search/autocomplete flows: when suggestion results appear dynamically, screen readers are now notified via an off-screen live region (role="status"), so users get immediate audible feedback instead of a silent visual-only update.

Fixed Issues

$ #74840
PROPOSAL: #74840 (comment)

Tests

  1. Using Chrome+JAWS, open the web app
  2. Navigate using the tab key to the Account button and press Enter to activate it.
  3. Navigate using the tab key to the Security button and press Enter to activate it.
  4. Move to the Address input field.
  5. Start typing a partial address (e.g., “123 Main”) to trigger the auto-suggestion dropdown.
  6. Observe the screen reader announcement.
  7. When search suggestions appear, verify the screen reader announces the availability of suggestions and allows navigation through them. Example announcement: “Suggestions available. Use up and down arrow keys to navigate.”
  • 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-26.at.3.41.45.PM.mov
Android: mWeb Chrome
Screen.Recording.2026-02-26.at.3.47.07.PM.mov
iOS: Native
Screen.Recording.2026-02-26.at.3.31.34.PM.mov
iOS: mWeb Safari
Screen.Recording.2026-02-26.at.4.01.06.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2026-03-01.at.9.30.02.AM.mov

@melvin-bot

melvin-bot Bot commented Feb 20, 2026

Copy link
Copy Markdown

Hey, I noticed you changed src/languages/en.ts in a PR from a fork. For security reasons, translations are not generated automatically for PRs from forks.

If you want to automatically generate translations for other locales, an Expensify employee will have to:

  1. Look at the code and make sure there are no malicious changes.
  2. Run the Generate static translations GitHub workflow. If you have write access and the K2 extension, you can simply click: [this button]

Alternatively, if you are an external contributor, you can run the translation script locally with your own OpenAI API key. To learn more, try running:

npx ts-node ./scripts/generateTranslations.ts --help

Typically, you'd want to translate only what you changed by running npx ts-node ./scripts/generateTranslations.ts --compare-ref main

@melvin-bot

melvin-bot Bot commented Feb 20, 2026

Copy link
Copy Markdown

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

@codecov

codecov Bot commented Feb 21, 2026 •

Copy link
Copy Markdown

Codecov Report

❌ Looks like you've decreased code coverage for some files. Please write tests to increase, or at least maintain, the existing level of code coverage. See our documentation here for how to interpret this table.

Files with missing lines Coverage Δ
src/CONST/index.ts 92.56% <ø> (ø)
src/styles/index.ts 45.87% <ø> (-0.52%) ⬇️
...ListWithSections/BaseSelectionListWithSections.tsx 74.41% <71.42%> (+0.09%) ⬆️
src/components/AddressSearch/index.tsx 48.24% <50.00%> (+0.20%) ⬆️
src/components/SelectionList/BaseSelectionList.tsx 66.81% <34.48%> (-4.34%) ⬇️
...ListWithSections/BaseSelectionListWithSections.tsx 70.76% <29.41%> (-2.77%) ⬇️
... and 25 files with indirect coverage changes

@rushatgabhane

Copy link
Copy Markdown
Member

@marufsharifi how's this one lookin? is this ready for review?

@melvin-bot
melvin-bot Bot requested review from suneox and trjExpensify and removed request for a team March 2, 2026 06:27
@melvin-bot

melvin-bot Bot commented Mar 2, 2026

Copy link
Copy Markdown

@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 removed the request for review from a team March 2, 2026 06:27

const scrollTimeoutRef = useRef<NodeJS.Timeout | null>(null);

useEffect(() => {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❌ CONSISTENCY-3 (docs)

The entire suggestions-announcement logic — suggestionsAnnouncement state, lastAnnouncementKeyRef, isMacOSChromeWeb detection, the useEffect with platform branching, and the <Text> live-region JSX — is copy-pasted nearly identically across four components:

  • AddressSearch/index.tsx
  • SelectionList/BaseSelectionList.tsx
  • SelectionList/SelectionListWithSections/BaseSelectionListWithSections.tsx
  • SelectionListWithSections/BaseSelectionListWithSections.tsx

Extract this into a reusable custom hook (e.g. useSuggestionsAnnouncement) that encapsulates the state, effect, and returns the announcement JSX element. This would also let you create platform-specific implementations (.web.ts / .native.ts) to eliminate inline Platform.OS checks.


Please rate this suggestion with 👍 or 👎 to help us improve! Reactions are used to monitor reviewer efficiency.

lastAnnouncementKeyRef.current = announcementKey;
const announcementText = translate('search.suggestionsAvailable');
if (Platform.OS === CONST.PLATFORM.WEB) {
// eslint-disable-next-line react-hooks/set-state-in-effect

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❌ CONSISTENCY-5 (docs)

eslint-disable-next-line react-hooks/set-state-in-effect lacks an accompanying justification comment. Add a reason, e.g.:

// setState is intentional here — the live-region text must differ on each trigger so screen readers re-announce it.
// eslint-disable-next-line react-hooks/set-state-in-effect

Please rate this suggestion with 👍 or 👎 to help us improve! Reactions are used to monitor reviewer efficiency.

lastAnnouncementKeyRef.current = announcementKey;
const announcementText = translate('search.suggestionsAvailable', {count: data.length});
if (Platform.OS === CONST.PLATFORM.WEB) {
// eslint-disable-next-line react-hooks/set-state-in-effect

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❌ CONSISTENCY-5 (docs)

eslint-disable-next-line react-hooks/set-state-in-effect lacks an accompanying justification comment. Add a reason explaining why calling setState inside this useEffect is intentional.


Please rate this suggestion with 👍 or 👎 to help us improve! Reactions are used to monitor reviewer efficiency.

lastAnnouncementKeyRef.current = announcementKey;
const announcementText = translate('search.suggestionsAvailable', {count: itemsCount});
if (Platform.OS === CONST.PLATFORM.WEB) {
// eslint-disable-next-line react-hooks/set-state-in-effect

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❌ CONSISTENCY-5 (docs)

eslint-disable-next-line react-hooks/set-state-in-effect lacks an accompanying justification comment. Add a reason explaining why calling setState inside this useEffect is intentional.


Please rate this suggestion with 👍 or 👎 to help us improve! Reactions are used to monitor reviewer efficiency.

lastAnnouncementKeyRef.current = announcementKey;
const announcementText = translate('search.suggestionsAvailable', {count: flattenedSections.allOptions.length});
if (Platform.OS === CONST.PLATFORM.WEB) {
// eslint-disable-next-line react-hooks/set-state-in-effect

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❌ CONSISTENCY-5 (docs)

eslint-disable-next-line react-hooks/set-state-in-effect lacks an accompanying justification comment. Add a reason explaining why calling setState inside this useEffect is intentional.


Please rate this suggestion with 👍 or 👎 to help us improve! Reactions are used to monitor reviewer efficiency.

Comment thread src/components/AddressSearch/index.tsx Outdated
const containerRef = useRef<View>(null);
const [suggestionsAnnouncement, setSuggestionsAnnouncement] = useState({id: 0, text: ''});
const lastAnnouncementKeyRef = useRef('');
const isMacOSChromeWeb = Platform.OS === CONST.PLATFORM.WEB && Browser.getBrowser() === CONST.BROWSER.CHROME && /Macintosh|Mac OS X/i.test(navigator.userAgent);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❌ CONSISTENCY-2 (docs)

The regex /Macintosh|Mac OS X/i is a magic value repeated in four files. Extract the macOS-Chrome detection into the Browser utility module (e.g. Browser.isMacOSChrome()) so every consumer shares a single, named constant and logic.


Please rate this suggestion with 👍 or 👎 to help us improve! Reactions are used to monitor reviewer efficiency.


lastAnnouncementKeyRef.current = announcementKey;
const announcementText = translate('search.suggestionsAvailable');
if (Platform.OS === CONST.PLATFORM.WEB) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❌ CONSISTENCY-1 (docs)

Inline Platform.OS === CONST.PLATFORM.WEB checks are used to branch between web live-region rendering and native AccessibilityInfo.announceForAccessibility, and this pattern is repeated across four components. Extract the announcement behaviour into a custom hook with platform-specific file implementations (.web.ts / .native.ts) to remove the inline platform checks.


Please rate this suggestion with 👍 or 👎 to help us improve! Reactions are used to monitor reviewer efficiency.

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

Copy link
Copy Markdown

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: 4eb0d39747

ℹ️ About Codex in GitHub

Your team has set up Codex to 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 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines +115 to +117
if (!isFocused || !displayListViewBorder) {
lastAnnouncementKeyRef.current = '';
return;

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Gate suggestion announcement on real search results

This effect announces search.suggestionsAvailable as soon as displayListViewBorder is true, but that flag is layout-driven and can be true while the autocomplete list is still loading or transitioning between queries; in those cases users can hear “Suggestions available” even when there are no actionable suggestions yet (or none for the new query), which is misleading for screen-reader navigation. Please gate the announcement on an actual non-empty suggestion result state (or a verified non-loading result state) before updating the live region / calling announceForAccessibility.

Useful? React with 👍 / 👎.

@suneox

suneox commented Mar 4, 2026

Copy link
Copy Markdown
Contributor

@marufsharifi Could you check the failing pipeline and resolve the conflicts?
Also, please review and respond to the AI comments. Thanks!

const containerRef = useRef<View>(null);
const [suggestionsAnnouncement, setSuggestionsAnnouncement] = useState({id: 0, text: ''});
const lastAnnouncementKeyRef = useRef('');
const isMacOSChromeWeb = Platform.OS === CONST.PLATFORM.WEB && getBrowser() === CONST.BROWSER.CHROME && /Macintosh|Mac OS X/i.test(navigator.userAgent);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Could you explain why we need specific isMacOSChromeWeb and how about on another browser?
I see that you added this in 4 places with the same condition. If this is really needed, should we move it to a utility function? and we should add unit tests for it

Comment thread src/languages/de.ts
Comment on lines +7315 to +7318
suggestionsAvailable: ({count}: {count?: number} = {}) => {
const countText = count ? `${count} ${count === 1 ? 'Ergebnis' : 'Ergebnisse'}. ` : '';
return `Vorschläge verfügbar. ${countText}Verwenden Sie die Pfeiltasten nach oben und unten zum Navigieren.`;
},

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Could you confirm the translation on Slack? Also, where does this translation come from?

Current message also different from expected result

When search suggestions appear, verify the screen reader announces the availability of suggestions and allows navigation through them. Example announcement: “Suggestions available. Use up and down arrow keys to navigate.”

ref={containerRef}
fsClass={forwardedFSClass}
>
{Platform.OS === CONST.PLATFORM.WEB && !!suggestionsAnnouncement.text && (

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Please using getPlatform util to make consistent with another place

key={suggestionsAnnouncement.id}
role={isMacOSChromeWeb ? CONST.ROLE.ALERT : CONST.ROLE.STATUS}
accessibilityLiveRegion={isMacOSChromeWeb ? 'assertive' : undefined}
style={isMacOSChromeWeb ? styles.screenReaderOnlyLiveRegion : styles.hiddenElementOutsideOfWindow}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Do we need to apply different hidden style for this one?

// eslint-disable-next-line react-hooks/set-state-in-effect
setSuggestionsAnnouncement((prev) => {
const id = prev.id + 1;
const marker = isMacOSChromeWeb && id % 2 === 0 ? '\u2060' : '';

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

What does it mean for u2060? please mention or create constant

@rushatgabhane

Copy link
Copy Markdown
Member

@marufsharifi

Copy link
Copy Markdown
Author

@rushatgabhane, should i re-open this based on this comment? thanks.

@suneox

suneox commented Mar 7, 2026

Copy link
Copy Markdown
Contributor

@rushatgabhane, should i re-open this based on this comment? thanks.

@marufsharifi I think you should create a separate PR for #77390 and not include the code changes for #74840.

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.

3 participants