Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: implement useArrowKeyFocusManager in EmojiPickerMenu #34581

Merged

Conversation

TMisiukiewicz
Copy link
Contributor

@TMisiukiewicz TMisiukiewicz commented Jan 16, 2024

Details

Fixed Issues

$ #30911
$ #32644
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console
  1. Open web app and open emoji picker in the report
  2. Press arrow down and verify focus is on the first available emoji
  3. Press arrow right and verify focus is on the next available emoji
  4. Press arrow left and verify focus is on the emoji left to the last focused emoji
  5. Press arrow up and verify focus is on the search input
  6. Type "smile" in search input
  7. Repeat steps 2-5
  8. Remove the last letter
  9. Verify input is still focused

Offline tests

n/a

QA Steps

  • Verify that no errors appear in the JS console
  1. Open web app and open emoji picker in the report
  2. Press arrow down and verify focus is on the first available emoji
  3. Press arrow right and verify focus is on the next available emoji
  4. Press arrow left and verify focus is on the emoji left to the last focused emoji
  5. Press arrow up and verify focus is on the search input
  6. Type "smile" in search input
  7. Repeat steps 2-5
  8. Remove the last letter
  9. 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/libs/EmojiUtils.ts Outdated Show resolved Hide resolved
@TMisiukiewicz TMisiukiewicz force-pushed the feat/implement-horizontal-arrows branch from 309f463 to 773787f Compare January 22, 2024 14:36
@roryabraham roryabraham requested a review from gedu January 24, 2024 05:40
@TMisiukiewicz TMisiukiewicz marked this pull request as ready for review January 24, 2024 12:36
@TMisiukiewicz TMisiukiewicz requested a review from a team as a code owner January 24, 2024 12:36
@melvin-bot melvin-bot bot removed the request for review from a team January 24, 2024 12:36
@jjcoffee
Copy link
Contributor

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
Copy link
Contributor

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

@TMisiukiewicz
Copy link
Contributor Author

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

Copy link
Contributor

@jjcoffee jjcoffee left a comment

Choose a reason for hiding this comment

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

LGTM!

@MariaHCD MariaHCD requested review from gedu and adhorodyski January 29, 2024 06:36
@jjcoffee
Copy link
Contributor

jjcoffee commented Feb 1, 2024

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

@MariaHCD MariaHCD merged commit dc748de into Expensify:main Feb 1, 2024
16 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Feb 1, 2024

✋ 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
Copy link
Contributor

👋 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
Copy link
Contributor

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
Copy link
Contributor Author

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

@TMisiukiewicz
Copy link
Contributor Author

opened a PR with a fix #35796

@OSBotify
Copy link
Contributor

OSBotify commented Feb 5, 2024

🚀 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
Copy link
Contributor

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

let newFocusedIndex = currentFocusedIndex;

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

Choose a reason for hiding this comment

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

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

});
}, [allowHorizontalArrowKeys, disableCyclicTraversal, disabledIndexes, maxIndex]);

useKeyboardShortcut(CONST.KEYBOARD_SHORTCUTS.ARROW_LEFT, arrowLeftCallback, arrowConfig);
Copy link
Contributor

Choose a reason for hiding this comment

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

This cause a regression #38076

@rayane-djouah
Copy link
Contributor

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

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.

10 participants