feat: implement useArrowKeyFocusManager in EmojiPickerMenu #34581

TMisiukiewicz · 2024-01-16T14:52:32Z

Details

Fixed Issues

$ #30911
$ #32644
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Open web app and open emoji picker in the report
Press arrow down and verify focus is on the first available emoji
Press arrow right and verify focus is on the next available emoji
Press arrow left and verify focus is on the emoji left to the last focused emoji
Press arrow up and verify focus is on the search input
Type "smile" in search input
Repeat steps 2-5
Remove the last letter
Verify input is still focused

Offline tests

n/a

QA Steps

Verify that no errors appear in the JS console

Open web app and open emoji picker in the report
Press arrow down and verify focus is on the first available emoji
Press arrow right and verify focus is on the next available emoji
Press arrow left and verify focus is on the emoji left to the last focused emoji
Press arrow up and verify focus is on the search input
Type "smile" in search input
Repeat steps 2-5
Remove the last letter
Verify input is still focused

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
- MacOS: Desktop
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 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
  - If any non-english text was added/modified, I verified the translation was requested/reviewed 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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.js 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 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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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.

Screenshots/Videos

Android: Native

ANDROID.mov

Android: mWeb Chrome

ANDROID.WEB.mov

iOS: Native

IOS.mov

iOS: mWeb Safari

IOS.WEB.mov

MacOS: Chrome / Safari

WEB.mov

MacOS: Desktop

DESKTOP.mov

src/hooks/useArrowKeyFocusManager.ts

src/libs/EmojiUtils.ts

src/components/EmojiPicker/EmojiPickerMenu/index.js

src/hooks/useArrowKeyFocusManager.ts

jjcoffee · 2024-01-26T10:37:11Z

Thanks, the fix works nicely! Can you fix the lint error too?

I can see it happens also on staging so it's not related to the changes made in the PR.

Ah yeah I see the same too now (asked on Slack about it). I don't think it's really within scope of this PR to fix unless you find something obvious!

jjcoffee · 2024-01-26T10:54:47Z

Following up, there's an open issue #34522 for the Android layout bug I reported, so no need to fix that here!

TMisiukiewicz · 2024-01-26T11:19:45Z

great to hear there is already a ticket for a layout bug 🙌 I just pushed an update that should fix the linting error

jjcoffee

LGTM!

jjcoffee · 2024-02-01T09:49:02Z

@MariaHCD I think we're good to merge this as @gedu and @adhorodyski already reviewed?

OSBotify · 2024-02-01T14:00:19Z

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

aldo-expensify · 2024-02-02T23:05:37Z

👋 this is causing this deploy blocker: #35720

Summary: In mobile, now the Search input inside the emoji popup gets focused automatically causing the keyboard to open. The autofocus did only happen in big screens in the past.

@TMisiukiewicz

aldo-expensify · 2024-02-03T00:25:01Z

I prepared a revert here in case this is the path you want to follow: #35737 (comment), but didn't merged it yet in case you want to try to fix this.

TMisiukiewicz · 2024-02-05T07:14:20Z

hi @aldo-expensify trying to fix it now, so hopefully we'll avoid reverting

TMisiukiewicz · 2024-02-05T08:30:15Z

opened a PR with a fix #35796

OSBotify · 2024-02-05T22:53:27Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.36-5 🚀

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

jjcoffee · 2024-02-21T10:09:22Z

Coming from #36059, we missed a case for allowing navigation with left/right arrow keys within the search input whilst it is focused.

Ollyws · 2024-03-23T12:04:36Z

src/hooks/useArrowKeyFocusManager.ts

 let newFocusedIndex = currentFocusedIndex;

 while (disabledIndexes.includes(newFocusedIndex)) {
- newFocusedIndex = newFocusedIndex > 0 ? newFocusedIndex - 1 : maxIndex;
+ newFocusedIndex -= allowHorizontalArrowKeys ? itemsPerRow : 1;
+ if (newFocusedIndex < 0) {


This caused the selection to dissapear when focusing the top index in report action context menu (#36245) we fixed this in #38007

eh2077 · 2024-04-09T07:40:31Z

src/hooks/useArrowKeyFocusManager.ts

+ });
+ }, [allowHorizontalArrowKeys, disableCyclicTraversal, disabledIndexes, maxIndex]);
+
+ useKeyboardShortcut(CONST.KEYBOARD_SHORTCUTS.ARROW_LEFT, arrowLeftCallback, arrowConfig);


This cause a regression #38076

rayane-djouah · 2024-09-08T19:54:36Z

FYI, This PR caused this issue: #47272. You can find more info in this comment: #47272 (comment)

TMisiukiewicz mentioned this pull request Jan 16, 2024

[HOLD for payment 2023-12-18] [HOLD for payment 2023-12-15] [$500] Chat - Focus is lost after deleting letter in a word in the emoji search bar #32644

Closed

6 tasks

gedu reviewed Jan 22, 2024

View reviewed changes

src/hooks/useArrowKeyFocusManager.ts Outdated Show resolved Hide resolved

gedu reviewed Jan 22, 2024

View reviewed changes

src/hooks/useArrowKeyFocusManager.ts Outdated Show resolved Hide resolved

gedu reviewed Jan 22, 2024

View reviewed changes

src/libs/EmojiUtils.ts Outdated Show resolved Hide resolved

TMisiukiewicz added 13 commits January 22, 2024 15:27

add left and right arrow support in useArrowKeyFocusManager

9fcd8ed

update useArrowKeyFocusManager down & up behavior

b2f6d98

add arrow key to hook

718b67b

update useArrowKeyFocusManager to correctly find next index

fcc45b8

use horizontal arrows with emoji picker menu

37525aa

remove unused condition

b143573

cleanup emoji picker menu

222ba38

more cleanup for horizontal arrows

e6e324b

reduce diff between mobile and web

d053504

fix cyclic traversal focus

4e2d916

update naming to focusedIndex

613bc28

reduce diff

e8d35df

code review updates

773787f

TMisiukiewicz force-pushed the feat/implement-horizontal-arrows branch from 309f463 to 773787f Compare January 22, 2024 14:36

roryabraham requested a review from gedu January 24, 2024 05:40

adhorodyski reviewed Jan 24, 2024

View reviewed changes

src/components/EmojiPicker/EmojiPickerMenu/index.js Outdated Show resolved Hide resolved

adhorodyski reviewed Jan 24, 2024

View reviewed changes

src/hooks/useArrowKeyFocusManager.ts Show resolved Hide resolved

adhorodyski reviewed Jan 24, 2024

View reviewed changes

src/hooks/useArrowKeyFocusManager.ts Show resolved Hide resolved

adhorodyski reviewed Jan 24, 2024

View reviewed changes

src/hooks/useArrowKeyFocusManager.ts Show resolved Hide resolved

TMisiukiewicz added 4 commits January 24, 2024 12:07

add newlines for better readability

61287bc

memoize disabled indexes

54197c0

remove unnecessary condition

e916dab

Merge branch 'main' into feat/implement-horizontal-arrows

46dadfd

TMisiukiewicz marked this pull request as ready for review January 24, 2024 12:36

TMisiukiewicz requested a review from a team as a code owner January 24, 2024 12:36

melvin-bot bot removed the request for review from a team January 24, 2024 12:36

jjcoffee mentioned this pull request Jan 26, 2024

[PAID] [LOW] [$500] Mweb/Chrome - Status - In status, emoji selected is not shown in preview as selected #33679

Closed

6 tasks

TMisiukiewicz added 2 commits January 26, 2024 12:18

fix linting

d6789ed

Merge branch 'main' into feat/implement-horizontal-arrows

2dba4c6

jjcoffee approved these changes Jan 26, 2024

View reviewed changes

MariaHCD approved these changes Jan 29, 2024

View reviewed changes

MariaHCD requested review from gedu and adhorodyski January 29, 2024 06:36

MariaHCD merged commit dc748de into Expensify:main Feb 1, 2024
16 checks passed

github-actions bot mentioned this pull request Feb 2, 2024

Deploy Checklist: New Expensify 2024-02-02 #35673

Closed

francoisl mentioned this pull request Feb 2, 2024

[$500] [HOLD for payment 2024-02-14] mweb - Compose - Tapping emoji picker, keypad pops up on emoji box page #35720

Closed

6 tasks

aldo-expensify mentioned this pull request Feb 2, 2024

Revert "feat: implement useArrowKeyFocusManager in EmojiPickerMenu" #35737

Closed

jjcoffee mentioned this pull request Feb 14, 2024

[$500] [MEDIUM] Migrate the EmojiPickerMenu to Flashlist #30911

Closed

jjcoffee mentioned this pull request Feb 21, 2024

[HOLD for payment 2024-02-22][$500] The back and forward keys are not working properly for navigating back to a characters #36059

Closed

6 tasks

Ollyws reviewed Mar 23, 2024

View reviewed changes

Ollyws mentioned this pull request Mar 23, 2024

[HOLD for payment 2024-03-25] [$500] Message action menu - Last option is not selected when pressing up key #36245

Closed

6 tasks

eh2077 reviewed Apr 9, 2024

View reviewed changes

eh2077 mentioned this pull request Apr 9, 2024

[HOLD for payment 2024-04-05] HIGH: [Mentions] [$500] Pressingrightarrow key does nothing when mentioning and keeping the cursor after @ in the compose box #38076

Closed

6 tasks

rayane-djouah mentioned this pull request Sep 8, 2024

[HOLD for Payment 2024-09-6][$250] clicking enter on emoji selector for status results in leaving status pane #47272

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: implement useArrowKeyFocusManager in EmojiPickerMenu #34581

feat: implement useArrowKeyFocusManager in EmojiPickerMenu #34581

TMisiukiewicz commented Jan 16, 2024 •

edited

Loading

jjcoffee commented Jan 26, 2024

jjcoffee commented Jan 26, 2024

TMisiukiewicz commented Jan 26, 2024

jjcoffee left a comment

jjcoffee commented Feb 1, 2024

OSBotify commented Feb 1, 2024

aldo-expensify commented Feb 2, 2024

aldo-expensify commented Feb 3, 2024

TMisiukiewicz commented Feb 5, 2024

TMisiukiewicz commented Feb 5, 2024

OSBotify commented Feb 5, 2024

jjcoffee commented Feb 21, 2024

Ollyws Mar 23, 2024

eh2077 Apr 9, 2024

rayane-djouah commented Sep 8, 2024

feat: implement useArrowKeyFocusManager in EmojiPickerMenu #34581

feat: implement useArrowKeyFocusManager in EmojiPickerMenu #34581

Conversation

TMisiukiewicz commented Jan 16, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

jjcoffee commented Jan 26, 2024

jjcoffee commented Jan 26, 2024

TMisiukiewicz commented Jan 26, 2024

jjcoffee left a comment

Choose a reason for hiding this comment

jjcoffee commented Feb 1, 2024

OSBotify commented Feb 1, 2024

aldo-expensify commented Feb 2, 2024

aldo-expensify commented Feb 3, 2024

TMisiukiewicz commented Feb 5, 2024

TMisiukiewicz commented Feb 5, 2024

OSBotify commented Feb 5, 2024

jjcoffee commented Feb 21, 2024

Ollyws Mar 23, 2024

Choose a reason for hiding this comment

eh2077 Apr 9, 2024

Choose a reason for hiding this comment

rayane-djouah commented Sep 8, 2024

TMisiukiewicz commented Jan 16, 2024 •

edited

Loading