navigate to Search page after fully closing modal on keyboard shortcut #16381

situchan · 2023-03-22T06:58:14Z

Details

Navigate to new page only after modal is fully closed, which means focus is ready to be transferred.

Fixed Issues

$ #15276
PROPOSAL: #15276 (comment)

Tests

Same as QA step

Verify that no errors appear in the JS console

Offline tests

Same as QA step

QA Steps

Login with any account on web/desktop app
Open FAB menu
Press CTRL + K
Verify that FAB menu closes, search page opens and input field is focused automatically
Close search page
Right click any chat message to show context menu
Press CTRL + Shift + K
Verify that context menu closes, new group page opens and input field is focused automatically

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 / Chrome
- iOS / native
- iOS / 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 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 correct English and 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 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(themeColors.componentBG)
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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

web.mov

Mobile Web - Chrome

mchrome.mov

Mobile Web - Safari

msafari.mp4

Desktop

desktop.mov

iOS

ios.mp4

Android

android.mov

MelvinBot · 2023-03-22T06:58:21Z

@hayata-suenaga @Santhosh-Sellavel One of you needs to 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]

getusha · 2023-03-22T08:16:37Z

@situchan The input doesn't seem to be focused on the EmojiPicker navigating using Ctrl + k can you take a look at it?

Screen.Recording.2023-03-22.at.1.13.28.AM.mov

getusha · 2023-03-22T09:02:01Z

FAB

Screen.Recording.2023-03-22.at.1.28.45.AM.mov

Add attachment modal

Screen.Recording.2023-03-22.at.1.29.17.AM.mov

Context Menu

Screen.Recording.2023-03-22.at.1.30.09.AM.mov

Delete Modal

Screen.Recording.2023-03-22.at.1.31.48.AM.mov

Start a call modal

Screen.Recording.2023-03-22.at.1.34.01.AM.mov

Attachment Modal

Screen.Recording.2023-03-22.at.1.35.07.AM.mov

Keyboard shortcuts Modal

Screen.Recording.2023-03-22.at.1.36.45.AM.mov

getusha · 2023-03-22T09:02:36Z

I will continue testing...

situchan · 2023-03-22T09:50:03Z

@situchan The input doesn't seem to be focused on the EmojiPicker navigating using Ctrl + k can you take a look at it?

@getusha It works for me. Which browser / version is it?

getusha · 2023-03-22T12:20:29Z

@situchan Mac/Chrome and cloned your branch fix/15276-search-focus-on-shortcut

… shortcut

situchan · 2023-03-22T14:43:47Z

The input doesn't seem to be focused on the EmojiPicker navigating using Ctrl + k can you take a look at it?

We discussed here, found root cause and solution.
I pushed fix.

@getusha please pull again from https://github.com/situchan/Expensify/tree/fix/15276-search-focus-shortcut

getusha · 2023-03-22T14:50:41Z

@situchan Will test it again, thanks!
in the meantime i suggested to add comment to explain the onClose above, it can be confusing since we're calling the callback inside close function. can we do that?

situchan · 2023-03-22T14:52:50Z

@situchan Will test it again, thanks! in the meantime i suggested to add comment to explain the onClose above, it can be confusing since we're calling the callback inside close function. can we do that?

I don't see any suggestions. Did you submit?

getusha · 2023-03-22T15:11:18Z

I don't see any suggestions. Did you submit?

situchan · 2023-03-22T15:12:35Z

src/libs/actions/Modal.js

situchan · 2023-03-22T16:19:42Z

@getusha good suggestions. pushed updates. please check

getusha · 2023-03-22T17:13:55Z

@situchan I confirm this is fixed now

Screenshots/Videos

Web
#16381 (comment)

Desktop

Screen.Recording.2023-03-22.at.10.18.04.AM.mov

Mobile Web - Chrome

Screen.Recording.2023-03-22.at.6.23.49.AM.mov

Mobile Web - Safari

Screen.Recording.2023-03-22.at.6.25.46.AM.mov

Android

Screen.Recording.2023-03-22.at.10.01.47.AM.mov

situchan · 2023-03-22T17:19:18Z

@getusha thanks for testing. If you've done review, let's move to next step. So ping @Santhosh-Sellavel ready for review

situchan · 2023-03-23T16:28:20Z

@Santhosh-Sellavel kindly bump for review

Santhosh-Sellavel · 2023-03-23T18:32:33Z

@getusha thanks for testing. If you've done review, let's move to next step. So ping @Santhosh-Sellavel ready for review

I was just waiting for the ping from @getusha as you said above!

situchan · 2023-03-23T18:35:35Z

Oh, I thought 👍 from @getusha meant done for review. Sorry for confusion.
@getusha please comment here so we could get the PR reviewed and merged asap.

getusha · 2023-03-23T18:36:52Z

@Santhosh-Sellavel go ahead please, tested on several modals and it was working well, also resolved some issues thanks! 👍

Santhosh-Sellavel

@situchan

Seems to be working well for most cases.

Steps

Press CMD+K will open Search Page focus is set ✅
Now Press CMD+Shift+K will New Group is set ✅
Now Press CMD+K will open Search Page focus is not set ❌

Screen.Recording.2023-03-24.at.12.21.59.AM.mov

cc: @hayata-suenaga

src/libs/actions/Modal.js

Santhosh-Sellavel · 2023-03-23T19:01:09Z

@hayata-suenaga Let me know what should we do about this one #16381 (review), thanks!

situchan · 2023-03-23T19:20:36Z

Now Press CMD+K will open Search Page focus is not set ❌

Adding my cents here:
This is from default behavior of react-navigation.
Search page is already mounted so upon search page shortcut key on New group page, it just closes and go back to existing navigation route.
You can see that transition animation from New group page to Search page is reversed, which is same as when click back button.

…/15276-search-focus-shortcut

getusha · 2023-03-23T19:32:13Z

Also when the shortcut is used twice, it causes the focus be lost. Consequently, returning from the New group page does not trigger the focus, which means that this issue falls outside the scope of this.

Screen.Recording.2023-03-23.at.12.18.40.PM.mov

In my opinion, it would be better to handle the issue separately. This can be done by ensuring that the expected behavior is to close the previous page before opening a new one and preventing the navigation using the same shortcut twice or more, if it is decided that the issue is worth fixing.

Santhosh-Sellavel · 2023-03-23T19:36:16Z

Yeah, I got that too.

hayata-suenaga · 2023-03-23T22:48:11Z

@Santhosh-Sellavel yes I agree that this issue seems to be out of scope of the original issue.

situchan · 2023-03-24T14:57:17Z

@Santhosh-Sellavel do you have more feedback for us to address?

Santhosh-Sellavel · 2023-03-24T22:25:39Z

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 / Chrome
- iOS / native
- iOS / 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 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 correct English and 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 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(themeColors.componentBG)
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 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

Web

Screen.Recording.2023-03-25.at.3.47.32.AM.mov

Mobile Web - Chrome & Mobile Web - Safari

Screen.Recording.2023-03-25.at.3.44.16.AM.mov

Desktop

Desktop_short.mov

iOS & Android

Native_Search.mov

Santhosh-Sellavel

LGTM tests well. All you @hayata-suenaga!

hayata-suenaga

LGTM!

OSBotify · 2023-03-27T09:10:17Z

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

OSBotify · 2023-03-27T11:34:17Z

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.2.90-0 🚀

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

OSBotify · 2023-03-28T17:20:01Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.2.90-7 🚀

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

shubham1206agra · 2024-08-07T03:30:41Z

src/components/EmojiPicker/EmojiPicker.js

+     * @param {Boolean} isNavigating
+     */
+    hideEmojiPicker(isNavigating) {
+        if (isNavigating) { this.onModalHide = () => {}; }


This clearing of function caused a bug when navigating to the search page. More details here #23959

navigate to Search page after fully closing modal on keyboard shortcut

bc927c5

situchan requested a review from a team as a code owner March 22, 2023 06:58

melvin-bot bot requested review from hayata-suenaga and Santhosh-Sellavel and removed request for a team March 22, 2023 06:58

situchan mentioned this pull request Mar 22, 2023

[HOLD for payment 2023-04-04] [$4000] Web - NO focus on Search input field when opening FAB menu and then press on CTRL+K #15276

Closed

6 tasks

prevent focus on composer while emoji picker open and navigating from…

f995fd5

… shortcut

getusha reviewed Mar 22, 2023

View reviewed changes

src/libs/actions/Modal.js Outdated Show resolved Hide resolved

src/libs/actions/Modal.js Outdated Show resolved Hide resolved

update Modal close function description

e7a79eb

situchan mentioned this pull request Mar 22, 2023

[HOLD #16381]Composer is focused and able to type after opening Search page from keyboard shortcut while showing emoji picker #16423

Closed

6 tasks

Santhosh-Sellavel suggested changes Mar 23, 2023

View reviewed changes

src/libs/actions/Modal.js Outdated Show resolved Hide resolved

situchan added 2 commits March 23, 2023 19:24

rename onModalHideCallback to onModalCloseCallback

3d958c1

Merge branch 'main' of https://github.com/situchan/Expensify into fix…

ecbe591

…/15276-search-focus-shortcut

Santhosh-Sellavel approved these changes Mar 24, 2023

View reviewed changes

getusha approved these changes Mar 25, 2023

View reviewed changes

hayata-suenaga approved these changes Mar 27, 2023

View reviewed changes

hayata-suenaga merged commit 2f922c4 into Expensify:main Mar 27, 2023

OSBotify mentioned this pull request Mar 27, 2023

Deploy Checklist: New Expensify 2023-03-27 #16536

Closed

18 tasks

hoangzinh mentioned this pull request May 1, 2023

[$1000] Hover options are stuck when we close the reaction emoji picker using ESC #18217

Closed

6 tasks

tsa321 mentioned this pull request Dec 11, 2023

[HOLD for payment 2024-02-07] [$500] Search Page opens in Background when delete Reciept Confirm Modal is visible #29511

Closed

6 tasks

shubham1206agra reviewed Aug 7, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

navigate to Search page after fully closing modal on keyboard shortcut #16381

navigate to Search page after fully closing modal on keyboard shortcut #16381

situchan commented Mar 22, 2023

MelvinBot commented Mar 22, 2023

getusha commented Mar 22, 2023

getusha commented Mar 22, 2023

getusha commented Mar 22, 2023

situchan commented Mar 22, 2023

getusha commented Mar 22, 2023

situchan commented Mar 22, 2023

getusha commented Mar 22, 2023

situchan commented Mar 22, 2023

getusha commented Mar 22, 2023 •

edited

Loading

situchan commented Mar 22, 2023

situchan commented Mar 22, 2023

getusha commented Mar 22, 2023 •

edited

Loading

situchan commented Mar 22, 2023

situchan commented Mar 23, 2023

Santhosh-Sellavel commented Mar 23, 2023

situchan commented Mar 23, 2023

getusha commented Mar 23, 2023

Santhosh-Sellavel left a comment •

edited

Loading

Santhosh-Sellavel commented Mar 23, 2023

situchan commented Mar 23, 2023

getusha commented Mar 23, 2023

Santhosh-Sellavel commented Mar 23, 2023

hayata-suenaga commented Mar 23, 2023

situchan commented Mar 24, 2023

Santhosh-Sellavel commented Mar 24, 2023

Santhosh-Sellavel left a comment

hayata-suenaga left a comment

OSBotify commented Mar 27, 2023

OSBotify commented Mar 27, 2023

OSBotify commented Mar 28, 2023

shubham1206agra Aug 7, 2024

navigate to Search page after fully closing modal on keyboard shortcut #16381

navigate to Search page after fully closing modal on keyboard shortcut #16381

Conversation

situchan commented Mar 22, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MelvinBot commented Mar 22, 2023

getusha commented Mar 22, 2023

getusha commented Mar 22, 2023

FAB

Add attachment modal

Context Menu

Delete Modal

Start a call modal

Attachment Modal

Keyboard shortcuts Modal

getusha commented Mar 22, 2023

situchan commented Mar 22, 2023

getusha commented Mar 22, 2023

situchan commented Mar 22, 2023

getusha commented Mar 22, 2023

situchan commented Mar 22, 2023

getusha commented Mar 22, 2023 • edited Loading

situchan commented Mar 22, 2023

situchan commented Mar 22, 2023

getusha commented Mar 22, 2023 • edited Loading

Screenshots/Videos

situchan commented Mar 22, 2023

situchan commented Mar 23, 2023

Santhosh-Sellavel commented Mar 23, 2023

situchan commented Mar 23, 2023

getusha commented Mar 23, 2023

Santhosh-Sellavel left a comment • edited Loading

Choose a reason for hiding this comment

Santhosh-Sellavel commented Mar 23, 2023

situchan commented Mar 23, 2023

getusha commented Mar 23, 2023

Santhosh-Sellavel commented Mar 23, 2023

hayata-suenaga commented Mar 23, 2023

situchan commented Mar 24, 2023

Santhosh-Sellavel commented Mar 24, 2023

Reviewer Checklist

Screenshots/Videos

Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

hayata-suenaga left a comment

Choose a reason for hiding this comment

OSBotify commented Mar 27, 2023

OSBotify commented Mar 27, 2023

OSBotify commented Mar 28, 2023

shubham1206agra Aug 7, 2024

Choose a reason for hiding this comment

getusha commented Mar 22, 2023 •

edited

Loading

getusha commented Mar 22, 2023 •

edited

Loading

Santhosh-Sellavel left a comment •

edited

Loading