Skip to content

fix: button is announced without a state#84244

Closed
daledah wants to merge 21 commits intoExpensify:mainfrom
daledah:follow-up/76929
Closed

fix: button is announced without a state#84244
daledah wants to merge 21 commits intoExpensify:mainfrom
daledah:follow-up/76929

Conversation

@daledah
Copy link
Copy Markdown
Contributor

@daledah daledah commented Mar 5, 2026

Explanation of Change

Fixed Issues

$ #76929
PROPOSAL: #76929 (comment)

Tests

Prerequisite:

  • User is logged in
  • Use VoiceOver for IOS, use TallBack for Android
  1. Tab to focus on the required workspace and press Enter to activate it
  2. Once the Workspace menu is displayed, tab to focus on the "Categories" menu item and press Enter to activate it
  3. Tab to focus the More button and observe the screen reader announcement.
  4. Verify that: The accordion button should communicate its expanded or collapsed state to assistive technologies. When expanded, the button should indicate “expanded”, and when collapsed, it should indicate “collapsed”.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  • 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 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-19.at.14.47.21.mov
Android: mWeb Chrome
android-mweb.mov
iOS: Native ios
iOS: mWeb Safari ios-mweb
MacOS: Chrome / Safari web

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 5, 2026

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

@daledah daledah marked this pull request as ready for review March 5, 2026 08:14
@daledah daledah requested review from a team as code owners March 5, 2026 08:14
@melvin-bot
Copy link
Copy Markdown

melvin-bot bot commented Mar 5, 2026

@QichenZhu 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 request for a team March 5, 2026 08:15
@daledah
Copy link
Copy Markdown
Contributor Author

daledah commented Mar 5, 2026

Open PR for review. Since we fixed the .mm file, it cannot be hot-reloaded via Metro and requires a full rebuild. I'm currently having trouble rebuilding on iOS, so I'll add screenshots later.

Copy link
Copy Markdown
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.

Fix is good with product.

@QichenZhu
Copy link
Copy Markdown
Contributor

I'm currently having trouble rebuilding on iOS, so I'll add screenshots later.

@daledah, how's it going?

@daledah
Copy link
Copy Markdown
Contributor Author

daledah commented Mar 9, 2026

@QichenZhu it's working on the Android now, please move forward

android.mov

@QichenZhu
Copy link
Copy Markdown
Contributor

@QichenZhu it's working on the Android now, please move forward

@daledah, good to know it works on Android, but our main concern is the iOS side.

@daledah
Copy link
Copy Markdown
Contributor Author

daledah commented Mar 12, 2026

@QichenZhu i updated and the result belows:

result

@QichenZhu
Copy link
Copy Markdown
Contributor

@daledah, I'm wondering why this PR mixes the patch and accessibilityHint approaches?

@rushatgabhane
Copy link
Copy Markdown
Member

rushatgabhane commented Mar 13, 2026

good to know it works on Android, but our main concern is the iOS side.

@QichenZhu things may not work on simulator. please trigger Adhoc and ask for QA confirmation if needed on C+ channel

only if needed

@QichenZhu
Copy link
Copy Markdown
Contributor

QichenZhu commented Mar 13, 2026

@rushatgabhane, thanks for the heads up! I'll test on a physical device or ask in Slack for help once we settle on a solution.

@daledah
Copy link
Copy Markdown
Contributor Author

daledah commented Mar 19, 2026

@QichenZhu I updated to use accessibilityLabel instead of accessibilityHint. And we also need to set accessibilityHint to avoid being notified twice on iOS, like we did here

@QichenZhu
Copy link
Copy Markdown
Contributor

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
android-native.webm
Android: mWeb Chrome
android-web.webm
iOS: HybridApp
ios-native.mp4
iOS: mWeb Safari
ios-web.mp4
MacOS: Chrome / Safari mac-web

Copy link
Copy Markdown
Contributor

@QichenZhu QichenZhu left a comment

Choose a reason for hiding this comment

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

The test step says 'when expanded, the button should indicate "expanded"', but focus moves away from the button when expanded, so it may not be announced on all platforms. I think this is fine.

@melvin-bot melvin-bot bot requested a review from dangrous March 19, 2026 16:05
@rushatgabhane
Copy link
Copy Markdown
Member

btw if accessibilityHint isn't supported on web, we can use aria-description for web

@rushatgabhane
Copy link
Copy Markdown
Member

@MelvinBot review

@MelvinBot
Copy link
Copy Markdown
Contributor

Code Review

Overall approach (using accessibilityLabel to convey expand/collapse state + accessibilityHint="" to suppress duplicate announcements on native) is reasonable and follows the existing CalendarPicker pattern.

However, I found one issue:

Bug: Expand/Collapse logic is inverted

const accessibilityExpandState = isMenuVisible ? CONST.ACCESSIBILITY_LABELS.EXPAND : CONST.ACCESSIBILITY_LABELS.COLLAPSE;

When isMenuVisible is true (menu is open), this sets the label to "Expand" — but it should say "Collapse". The existing codebase convention in AnimatedCollapsible and ExpandCollapseArrowButton is:

accessibilityLabel={isExpanded ? CONST.ACCESSIBILITY_LABELS.COLLAPSE : CONST.ACCESSIBILITY_LABELS.EXPAND}

The label describes the action the button will perform: "Collapse" when expanded, "Expand" when collapsed. The PR does the opposite.

Fix: Swap the ternary:

const accessibilityExpandState = isMenuVisible ? CONST.ACCESSIBILITY_LABELS.COLLAPSE : CONST.ACCESSIBILITY_LABELS.EXPAND;

Other notes (non-blocking)

  • GenericPressable reorder is correct — moving accessibilityHint after {...props} ensures the fallback (props.accessibilityHint ?? props.accessibilityLabel) properly respects explicitly-passed values like accessibilityHint="".
  • Web behavior: accessibilityHint is not mapped on web, but that's fine here since the expand/collapse info is conveyed through accessibilityLabel (which maps to aria-label). The accessibilityHint="" only needs to suppress the duplicate announcement on native.
  • CONST.ACCESSIBILITY_LABELS strings ('Expand', 'Collapse') are hardcoded English — this is an existing pattern in the codebase, not introduced by this PR.

@QichenZhu
Copy link
Copy Markdown
Contributor

Good catch from Melvin. Since we changed 'collapsed' to 'collapse', we are announcing an action instead of the current state.

@dangrous
Copy link
Copy Markdown
Contributor

Ah that is confusing but I think makes sense?

@QichenZhu
Copy link
Copy Markdown
Contributor

@JmillsExpensify @dangrous @rushatgabhane could you confirm what's more user-friendly: announcing the current state ('Collapsed' / 'Expanded'), or the action the button will perform ('Expand' when collapsed, 'Collapse' when expanded)?

@dangrous
Copy link
Copy Markdown
Contributor

I've looked through accessibility guidelines and it's a little confusing but I think it is preferred to announce the current state (so expanded, collapsed), rather than the action.

I looked mainly at the aria-expanded here and the react docs here (which seems to imply we should ensure this is in the accessibilityState object as well as correctly setting aria-expanded

Does that make sense?

@rushatgabhane
Copy link
Copy Markdown
Member

I think it is preferred to announce the current state (so expanded, collapsed), rather than the action

that sounds good! @daledah could you please update the labels

@QichenZhu
Copy link
Copy Markdown
Contributor

@MelvinBot review

@MelvinBot
Copy link
Copy Markdown
Contributor

Code Review

The previous review's ternary inversion issue has been resolved — the PR now correctly uses EXPANDED/COLLAPSED (current state) per the team's decision. Overall approach looks good.

Bug: customText can be undefined

const accessibilityLabel = `${accessibilityExpandState}, ${customText}`;

When customText is not passed (it's an optional prop), this produces "Expanded, undefined". This affects at least two existing usages that don't pass customText:

  • src/components/ImportColumn.tsx (line ~226, isSplitButton={false})
  • src/components/ReportActionItem/ExportWithDropdownMenu.tsx (line ~110, uses default isSplitButton=true)

Suggested fix:

const buttonText = customText ?? selectedItem?.text ?? '';
const accessibilityLabel = `${accessibilityExpandState}, ${buttonText}`;

This mirrors the fallback already used for the button's text prop on line ~190: text={customText ?? selectedItem?.text ?? ''}.

Everything else looks correct

  • EXPANDED/COLLAPSED labels correctly reflect current state per team decision.
  • accessibilityHint="" properly suppresses duplicate announcements on iOS native, following the existing CalendarPicker pattern.
  • GenericPressable reorder ensures accessibilityHint after {...props} so the fallback (props.accessibilityHint ?? props.accessibilityLabel) respects explicitly-passed values like "".
  • Web behavior works since the state is conveyed through accessibilityLabel (→ aria-label), not accessibilityHint.

Copy link
Copy Markdown
Contributor

@QichenZhu QichenZhu left a comment

Choose a reason for hiding this comment

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

I looked mainly at the aria-expanded here and the react docs here (which seems to imply we should ensure this is in the accessibilityState object as well as correctly setting aria-expanded

@dangrous yeah, that's the original proposal we agreed on. We need a patch to let iOS support accessibilityState, but it didn't work on @daledah's side for some reason, even though it worked for me. So we switched to the current workaround. However, based on your and MelvinBot's comments, it's buggy and doesn't follow the standard.

@QichenZhu
Copy link
Copy Markdown
Contributor

Verified @MelvinBot's comment is fixed.

84244.mp4

@dangrous
Copy link
Copy Markdown
Contributor

dangrous commented Mar 24, 2026

OKay got it. Do we want to include the accessibilityState fix in here as well, just in case? I guess we should stick with at LEAST this fix if that one wasn't working during testing, but probably good to include both unless that would conflict with itself

@dangrous
Copy link
Copy Markdown
Contributor

Bumping the above - should we add both fixes, or stick with this slightly weird one for now? I'd prefer to get the accessibilityState in there and rely on that, but happy to include both if it won't cause conflicts.

@daledah
Copy link
Copy Markdown
Contributor Author

daledah commented Mar 26, 2026

@QichenZhu Could you please reapply the patch for the accessibilityState fix and verify on your side whether there are any conflicts?

@QichenZhu
Copy link
Copy Markdown
Contributor

@daledah sure, I can test it on my side.

@QichenZhu
Copy link
Copy Markdown
Contributor

NAB: button state is still announced as collapsed after expanding. This might be caused by a react-native bug iOS Accessibility Value Out of Sync #35774

RPReplay_Final1774580297-2026-03-27.03_02_47.179.mp4

@QichenZhu
Copy link
Copy Markdown
Contributor

I'd prefer to get the accessibilityState in there and rely on that, but happy to include both if it won't cause conflicts.

@rushatgabhane, the accessibilityState approach works in my testing, no workaround needed. Could you test the ad hoc build of PR #86499 (requested in Slack)? If it works, we can go with that PR, and keep this one open just in case.

cc @dangrous

@dangrous
Copy link
Copy Markdown
Contributor

Thanks for the progress here! Just reviewed the potential new PR

@daledah
Copy link
Copy Markdown
Contributor Author

daledah commented Apr 6, 2026

Closed because #86499 was merged

@daledah daledah closed this Apr 6, 2026
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.

6 participants