Add aria-expanded to ButtonWithDropdownMenu for screen reader accessibility#86499
Add aria-expanded to ButtonWithDropdownMenu for screen reader accessibility#86499roryabraham merged 4 commits intomainfrom
Conversation
…bility - Map accessibilityState.expanded to aria-expanded in BaseGenericPressable - Add accessibilityState prop to Button component - Pass expanded state from ButtonWithDropdownMenu to its trigger buttons - Patch React Native Fabric to announce both expanded and collapsed states on iOS Co-authored-by: Qichen Zhu <QichenZhu@users.noreply.github.com>
|
NAB: button state is still announced as collapsed after expanding. I believe it belongs to a larger issue related to the react-native bug iOS Accessibility Value Out of Sync #35774. It also happens on checkboxes. Therefore, we won't address it in this PR. RPReplay_Final1774578835-2026-03-27.03_16_47.486.mp4RPReplay_Final1774578748-2026-03-27.03_15_23.120.mp4 |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
There was a problem hiding this comment.
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 Issuessection 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
Testssection - I verified the steps for Staging and/or Production testing are in the
QA stepssection - 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 verified the steps for local testing are in the
- 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.
toggleReportand notonIconClick). - 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
- 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.
- 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 usingAvatarhave 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
thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor) - Any internal methods bound to
thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick) - 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
Avataris modified, I verified thatAvataris 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
Designlabel and/or tagged@Expensify/designso the design team can review the changes.
- If a new page is added, I verified it's using the
ScrollViewcomponent 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
mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps. - 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
RPReplay_Final1774994691.mp4
iOS: mWeb Safari
ios-web.mp4
MacOS: Chrome / Safari
mac-web.mov
|
🚧 @MonilBhavsar has triggered a test Expensify/App build. You can view the workflow run here. |
This comment has been minimized.
This comment has been minimized.
dangrous
left a comment
dangrous
left a comment
There was a problem hiding this comment.
This seems fine to me, I'm gonna get some of the react native experts to double check though!
melvin-bot
bot
requested review from
a team,
QichenZhu and
heyjennahay
and removed request for
a team
|
@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] |
|
Still working on getting react-native folks to review |
|
Based on Slack we feel that this is... fine? @QichenZhu can you handle conflicts please? We should also open an upstream PR for the bug if we haven't yet. Thanks! |
|
@MelvinBot please resolve the conflicts. |
Co-authored-by: Qichen Zhu <QichenZhu@users.noreply.github.com>
|
Resolved the merge conflict in |
|
@roryabraham 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] |
patches/react-native/details.md
Outdated
| - PR introducing patch: 🛑 | ||
|
|
||
|
|
||
| ### [react-native+0.83.1+034+fix-pressability-new-arch.patch](react-native+0.83.1+034+fix-pressability-new-arch.patch) |
There was a problem hiding this comment.
@MelvinBot react-native+0.83.1+034+fix-pressability-new-arch.patch has been deleted on main.
There was a problem hiding this comment.
Removed the stale 034 (fix-pressability-new-arch) documentation entry and renumbered our accessibility patch from 035 to 034 to fill the gap. Pushed in eda70c6.
This comment was marked as duplicate.
This comment was marked as duplicate.
The react-native+0.83.1+034+fix-pressability-new-arch.patch was deleted on main, so the documentation entry for it should not be in this PR. Renumbered the accessibility patch from 035 to 034 to fill the gap. Co-authored-by: Qichen Zhu <QichenZhu@users.noreply.github.com>
patches/react-native/details.md
Outdated
| ### [react-native+0.83.1+034+fix-fabric-collapsed-accessibility-announcement.patch](react-native+0.83.1+034+fix-fabric-collapsed-accessibility-announcement.patch) | ||
| - Reason: Fixes a Fabric regression where VoiceOver on iOS only announces "expanded" but never "collapsed" for elements with `accessibilityState.expanded`. In `RCTViewComponentView.mm`, the code uses `value_or(false)` which skips the announcement entirely when `expanded` is `false`. This patch changes the logic to use `has_value()` and correctly announce both "expanded" and "collapsed" states, matching the old architecture (Paper) behavior. | ||
| - Upstream PR/issue: 🛑 |
There was a problem hiding this comment.
Please create a detailed upstream issue with a minimal reproduction (not this repo), and ideally a pull request as well. We can adjust the compensation accordingly, but I'm unwilling to merge a new patch to React Native without an upstream issue.
There was a problem hiding this comment.
Thanks for reviewing! Created an upstream issue: facebook/react-native#56296. I'll try to open a PR later.
There was a problem hiding this comment.
@MelvinBot please include the upstream issue link facebook/react-native#56296 and remove the extra empty line at L256.
There was a problem hiding this comment.
Done — added the upstream issue link (facebook/react-native#56296) and removed the extra blank line. Pushed in 175103f.
Co-authored-by: Qichen Zhu <QichenZhu@users.noreply.github.com>
QichenZhu
left a comment
QichenZhu
left a comment
There was a problem hiding this comment.
Retested.
RPReplay_Final1774994691.mp4
roryabraham
left a comment
roryabraham
left a comment
There was a problem hiding this comment.
Awesome, thanks @QichenZhu
|
🚧 @roryabraham has triggered a test Expensify/App build. You can view the workflow run here. |
|
🧪🧪 Use the links below to test this adhoc build on Android, iOS, and Web. Happy testing! 🧪🧪
|
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
|
🚀 Deployed to staging by https://github.com/roryabraham in version: 9.3.52-0 🚀
Bundle Size Analysis (Sentry): |
|
I reviewed the PR diff. No help site changes are required. This PR is a pure accessibility fix — it adds |
|
QA team will validate the following Functional steps on Web
On Native apps
|
7 participants
Explanation of Change
Screen readers (JAWS, VoiceOver) do not announce the expanded/collapsed state of the "More" dropdown button on pages like Workspace Categories. This PR fixes the issue cross-platform:
Web fix: Adds
aria-expandedattribute support by:accessibilityState.expandedtoaria-expandedinBaseGenericPressable(alongside existingaria-checkedandaria-selectedmappings)accessibilityStateas a prop on theButtoncomponent and forwarding it toPressableWithFeedback{expanded: isMenuVisible}fromButtonWithDropdownMenuto its trigger buttonsiOS fix: Patches a Fabric regression in
RCTViewComponentView.mmwherevalue_or(false)causes VoiceOver to only announce "expanded" but never "collapsed". The patch changes the logic to usehas_value()and correctly announce both states, matching the old architecture (Paper) behavior.Fixed Issues
$ #76929
PROPOSAL: #76929 (comment)
Tests
Offline tests
N/A — This is a pure accessibility attribute change with no network dependency.
QA Steps
On iOS with VoiceOver:
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectiontoggleReportand notonIconClick)src/languages/*files and using the translation methodSTYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))npm run compress-svg)Avataris modified, I verified thatAvataris working as expected in all cases)Designlabel and/or tagged@Expensify/designso the design team can review the changes.ScrollViewcomponent to make it scrollable when more elements are added to the page.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
Android: Native
Accessibility attributes are set via React Native's accessibilityState which maps to native Android accessibility properties.
Android: mWeb Chrome
Same as web — aria-expanded attribute is rendered in the DOM.
iOS: Native
The React Native Fabric patch ensures VoiceOver correctly announces both "expanded" and "collapsed" states.
iOS: mWeb Safari
Same as web — aria-expanded attribute is rendered in the DOM.
MacOS: Chrome / Safari
Verified via automated browser test: the More button renders with
aria-expanded="false"when closed andaria-expanded="true"when the dropdown is open. The attribute toggles correctly on each interaction.