Sync keyboard navigation in SelectionList and PopoverMenu by WojtekBoman · Pull Request #39201 · Expensify/App

WojtekBoman · 2024-03-28T17:31:42Z

Details

This PR fixes focusing on SelectionList and PopoverMenu items when navigating with tab button and arrows. Previously, these buttons worked independently, now only one item on the list is focused when navigating using them.

How it works without a fix:

Screen.Recording.2024-03-29.at.10.36.13.mov

Fixed Issues

$ #36476 (comment)
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console

Verify that focusing on SelectionList items works properly:
1. Create a new workspace
2. Open Categories page
3. Navigate through the list of categories with tab and arrows and verify that only one element is focused.
Verify that focusing on PopoverMenu items works properly:
1. Open Workspaces section in Account Settings.
2. Click on the three dot menu on any workspace.
3. Navigate through the options of PopoverMenu with tab and arrows and verify that only one element is focused.

Offline tests

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

MacOS: Chrome / Safari

Screen.Recording.2024-03-29.at.09.59.26.mov

MacOS: Desktop

Screen.Recording.2024-03-29.at.09.50.19.mov

melvin-bot · 2024-03-29T14:47:33Z

@fedirjh 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]

fedirjh · 2024-04-01T19:20:37Z

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 tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- 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.js 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.
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: Native

CleanShot.2024-04-02.at.23.22.15.mp4

Android: mWeb Chrome

CleanShot.2024-04-02.at.23.21.21.mp4

CleanShot.2024-04-03.at.21.46.57.mp4

iOS: Native

CleanShot.2024-04-02.at.02.49.27.mp4

CleanShot.2024-04-02.at.20.08.49.mp4

iOS: mWeb Safari

CleanShot.2024-04-01.at.23.43.55.mp4

MacOS: Chrome / Safari

CleanShot.2024-04-01.at.23.34.53.mp4

MacOS: Desktop

CleanShot.2024-04-02.at.04.41.21.mp4

fedirjh · 2024-04-02T03:42:43Z

@WojtekBoman Could you please merge main ?

Bug: PopoverMenu inside report screens still have the same bug

Screen.Recording.2024-04-01.at.11.38.42.PM.mov

Crash: App crash on ios When I open currency selector inside the request money flow

CleanShot.2024-04-02.at.02.48.42.mp4

Verify that focusing on PopoverMenu items works properly:

This is not working on mobile (chrome and safari)

Video

CleanShot.2024-04-01.at.23.44.29.mp4

CleanShot.2024-04-02.at.04.32.36.mp4

fedirjh · 2024-04-02T22:46:15Z

@WojtekBoman The crash was fixed on IOS. However, the bug still persists in the PopoverMenu on small screens or mobile devices. Check these videos 👇 :

Video 1

CleanShot.2024-04-02.at.23.37.15.mp4

Video 2

CleanShot.2024-04-02.at.23.23.52.mp4

Video 3

CleanShot.2024-04-02.at.23.14.08.mp4

WojtekBoman · 2024-04-03T06:56:47Z

I'm still investigating this bug that appears on mobile browsers, I'll let you know when it's ready to check :)

Kicu

Review after fixing the focus bug.
LGTM 👍 good job

Kicu · 2024-04-03T14:25:20Z

src/components/Hoverable/index.tsx

    if (isDisabled || !hasHoverSupport()) {
-        return cloneElement(getReturnValue(props.children, false), {ref});
+        const child = getReturnValue(props.children, false);
+        return cloneElement(child, {ref: mergeRefs(ref, child.ref)});


great find 👍

src/hooks/useSyncFocus/index.ts

src/components/PopoverMenu.tsx

WojtekBoman · 2024-04-03T16:05:48Z

@fedirjh I believe that now it should work, but I'm not sure about bugs on Android:Native I can't reproduce that, for me Tab doesn't navigate on Native platforms. Issues that occur on mobile browsers have been resolved :)

fedirjh

Looks good to me.

pecanoro · 2024-04-05T11:48:55Z

We merged this to fix some bugs with the key arrow functionality, since this is a considerable refactor of similar logic, please make sure the bug doesn't show up here.

roryabraham · 2024-04-10T23:21:03Z

conflicts

WojtekBoman · 2024-04-11T08:18:30Z

@WojtekBoman Could you please check the failing Reassure Performance Test?

Yes, I'll take a look at it. I'll let you know when it's ready :)

WojtekBoman · 2024-04-11T09:36:04Z

@fedirjh Perf-tests have been fixed :)

OSBotify · 2024-04-12T20:02:01Z

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

WojtekBoman · 2024-04-15T16:10:32Z

@Kicu has found a regression related to this PR. I've already prepared a fix for that: #40234. You can find more details in the description of the attached PR

OSBotify · 2024-04-18T04:55:32Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.4.63-0 🚀

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

mallenexpensify · 2024-04-18T21:55:32Z

Possible regression from here, can @WojtekBoman and @fedirjh , 👀 plz.
FAB – Blue frame appears when navigate via FAB menu using Up/Down keys

cristipaval · 2024-04-19T17:20:04Z

Another possible regression: #40410

OSBotify · 2024-04-22T14:56:31Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.63-21 🚀

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

jayeshmangwani · 2024-05-06T13:54:15Z

src/components/SelectionList/BaseSelectionList.tsx

+            scrollToIndex(index, true);
+        },
+        isFocused,
+    });


When we are using the useArrowKeyFocusManager here, we should have passed the disabledIndexes props, which caused this issue: #40583

jayeshmangwani · 2024-07-12T09:13:26Z

src/components/SelectionList/BaseListItem.tsx

                onMouseDown={shouldPreventDefaultFocusOnSelectRow ? (e) => e.preventDefault() : undefined}
                nativeID={keyForList ?? ''}
                style={pressableStyle}
+                onFocus={onFocus}


Coming from this issue #41922, we have added the onFocus to BaseListItem in this PR. We already had the onMouseDown conditional prop passed, so the bug might have been there with the conditional onMouseDown prop but became visible after the onFocus change. When we long press the currency in CurrencySelection, it triggers the onFocus function, and we see a scroll to the long-pressed index. We have fixed this by removing the conditional onMouseDown in BaseListItem.

ZhenjaHorbach · 2025-02-04T07:46:32Z

src/hooks/useSyncFocus/index.ts

+            return;
+        }
+
+        ref.current?.focus();


Came from this issue
To prevent issues related with selector scrolls to the top when we scroll down quickly
We added preventScroll: true for focus
More details here

WojtekBoman added 3 commits March 28, 2024 16:12

Sync keyboard navigation in SelectionList and PopoverMenu

4b11894

Fix lint

e7c7817

Run prettier and fix lint warnings

ef22ff2

blazejkustra approved these changes Mar 29, 2024

View reviewed changes

WojtekBoman marked this pull request as ready for review March 29, 2024 14:47

WojtekBoman requested a review from a team as a code owner March 29, 2024 14:47

melvin-bot bot removed the request for review from a team March 29, 2024 14:47

melvin-bot bot requested a review from fedirjh March 29, 2024 14:47

WojtekBoman added 2 commits April 2, 2024 09:23

Merge branch 'main' into fix/sync-arrows-and-tab-navigation

178b927

Add useSyncFocus hook

f91e6d0

WojtekBoman added 3 commits April 3, 2024 09:05

Merge branch 'main' into fix/sync-arrows-and-tab-navigation

519c0a2

Fix passing ref to children of Hoverable when hover is not supported

f470b96

Add docs for useSyncFocus hook

cfe13d5

jayeshmangwani mentioned this pull request Apr 3, 2024

User can access the background list using the arrow keys while the RHP is open #39327

Merged

50 tasks

Kicu approved these changes Apr 3, 2024

View reviewed changes

Refactor useSyncFocus, rename PopoverMenuItem to FocusableMenuItem

315f815

fedirjh approved these changes Apr 4, 2024

View reviewed changes

melvin-bot bot requested a review from roryabraham April 4, 2024 00:00

Merge branch 'main' into fix/sync-arrows-and-tab-navigation

ead8292

WojtekBoman added 2 commits April 8, 2024 16:44

Merge branch 'main' into fix/sync-arrows-and-tab-navigation

a8fd58c

Add isFocused prop to useArrowKeyFocusManager

0d1f5b0

WojtekBoman requested a review from a team as a code owner April 8, 2024 15:13

revert

a3c3116

roryabraham previously approved these changes Apr 10, 2024

View reviewed changes

Merge branch 'main' into fix/sync-arrows-and-tab-navigation

3f4072c

WojtekBoman dismissed stale reviews from roryabraham and dannymcclain via 3f4072c April 11, 2024 07:50

Fix onFocusedIndexChange in BaseSelectionList

9bf097d

roryabraham approved these changes Apr 12, 2024

View reviewed changes

roryabraham merged commit 8d371c5 into Expensify:main Apr 12, 2024

WojtekBoman mentioned this pull request Apr 15, 2024

Add shouldSyncFocus prop to ListItem components #40234

Merged

50 tasks

github-actions bot mentioned this pull request Apr 18, 2024

Deploy Checklist: New Expensify 2024-04-18 #40392

Closed

NikkiWines mentioned this pull request Apr 18, 2024

Chat – Unable to open any + menu option using Up keys and Enter, when open it first time #40399

Closed

6 tasks

ShridharGoel mentioned this pull request Apr 18, 2024

Start chat - App crashes when pressing keyboard up key in Start chat list #40401

Closed

6 tasks

ishpaul777 mentioned this pull request Apr 18, 2024

FAB – Blue frame appears when navigate via FAB menu using Up/Down keys #40398

Closed

6 tasks

paultsimura mentioned this pull request Apr 19, 2024

[$250] Group - ‘Notification preferences’ page transition animation is broken #40426

Closed

6 tasks

cristipaval mentioned this pull request Apr 19, 2024

[$250] Tag - Tag list scrolls up when selecting a tag from the list #40410

Closed

6 tasks

suneox mentioned this pull request Apr 20, 2024

[HOLD for payment 2024-05-13] [$250] Web - Pressing on keyboard enter key on notification option of a room takes back two steps #40551

Closed

6 tasks

jnowakow mentioned this pull request May 6, 2024

[$500] Improve Tab Navigation & Accessibility #36476

Closed

6 tasks

jayeshmangwani reviewed May 6, 2024

View reviewed changes

jayeshmangwani mentioned this pull request May 6, 2024

[HOLD for payment 2024-05-06] [$250] Web - Group chat - Three presses on down arrow are required to bring selection back to top #40583

Closed

6 tasks

jayeshmangwani reviewed Jul 12, 2024

View reviewed changes

jayeshmangwani mentioned this pull request Jul 12, 2024

[$250] Web - User has to click twice to select currency if the currency is around the bottom #41922

Closed

6 tasks

ZhenjaHorbach reviewed Feb 4, 2025

View reviewed changes

Conversation

WojtekBoman commented Mar 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Mar 29, 2024

Uh oh!

fedirjh commented Apr 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

fedirjh commented Apr 2, 2024

Uh oh!

fedirjh commented Apr 2, 2024

Uh oh!

WojtekBoman commented Apr 3, 2024

Uh oh!

Kicu left a comment

Choose a reason for hiding this comment

Uh oh!

Kicu Apr 3, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

WojtekBoman commented Apr 3, 2024

Uh oh!

fedirjh left a comment

Choose a reason for hiding this comment

Uh oh!

pecanoro commented Apr 5, 2024

Uh oh!

roryabraham commented Apr 10, 2024

Uh oh!

WojtekBoman commented Apr 11, 2024

Uh oh!

WojtekBoman commented Apr 11, 2024

Uh oh!

OSBotify commented Apr 12, 2024

Uh oh!

WojtekBoman commented Apr 15, 2024

Uh oh!

OSBotify commented Apr 18, 2024

Uh oh!

mallenexpensify commented Apr 18, 2024

Uh oh!

cristipaval commented Apr 19, 2024

Uh oh!

OSBotify commented Apr 22, 2024

Uh oh!

jayeshmangwani May 6, 2024

Choose a reason for hiding this comment

Uh oh!

jayeshmangwani Jul 12, 2024

Choose a reason for hiding this comment

Uh oh!

ZhenjaHorbach Feb 4, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

12 participants

WojtekBoman commented Mar 28, 2024 •

edited

Loading

fedirjh commented Apr 1, 2024 •

edited

Loading