Prevent enter key event if the focused element is a clickable element by dukenv0307 · Pull Request #32464 · Expensify/App

dukenv0307 · 2023-12-05T04:04:49Z

Details

Prevent enter key event if the focused element is a clickable element

Fixed Issues

$ #21392
PROPOSAL: #21392 (comment)

Tests

Create a group chat
Click on plus icon > split bill
Enter amount to go to confirm page
Click on checkbox of one member
Use arrow key to focus another
Click enter key
Verify that the member which has the checkbox is focused is selected/de-selected

Verify that no errors appear in the JS console

Offline tests

QA Steps

Create a group chat
Click on plus icon > split bill
Enter amount to go to confirm page
Click on checkbox of one member
Use arrow key to focus another
Click enter key
Verify that the member which has the checkbox is focused is selected/de-selected

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2023-12-07.at.13.03.07.mov

Android: mWeb Chrome

Screen.Recording.2023-12-07.at.12.56.54.mov

iOS: Native

Screen.Recording.2023-12-07.at.13.06.12.mov

iOS: mWeb Safari

Screen.Recording.2023-12-07.at.12.56.23.mov

MacOS: Chrome / Safari

Screen.Recording.2023-12-07.at.12.17.32.mov

MacOS: Desktop

Screen.Recording.2023-12-07.at.13.11.51.mov

melvin-bot · 2023-12-05T04:05:05Z

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

dukenv0307 · 2023-12-05T04:07:47Z

@mollfpr Actually, when we use enter key the request is created because the button has pressOnEnter prop as true. That prevents us from testing and it's a known bug here #32294. So we should hold this PR until this bug is fixed to complete testing.

mollfpr · 2023-12-06T15:16:21Z

@dukenv0307 The PR for #32294 is merged. Would you like us to continue the testing?

dukenv0307 · 2023-12-06T15:21:30Z

Yes I will complete the PR tomorrow.

dukenv0307 · 2023-12-07T06:22:46Z

@mollfpr Please help to continue reviewing the PR.

mollfpr · 2023-12-14T13:14:00Z

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 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(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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

32464.Android.mp4

Android: mWeb Chrome

32464.mWeb-Chrome.mp4

iOS: Native

32464.iOS.mp4

iOS: mWeb Safari

32464.mWeb-Safari.mp4

MacOS: Chrome / Safari

32464.Web.mp4

MacOS: Desktop

32464.Desktop.mp4

mollfpr

Selecting the member with the arrow keys is not working, and with the highlight tab, the member is sometimes set twice.

Screen.Recording.2023-12-18.at.09.51.03.mp4

mollfpr · 2023-12-16T13:56:28Z

            shouldShowReferralModal: false,
            errorMessage: '',
            paginationPage: 1,
+            disableEnterShortCut: isNative ? false : this.handleFocusIn(),


Why we are doing this? handleFocusIn is not returning anything.

dukenv0307 · 2023-12-18T06:19:22Z

@mollfpr I have a question here. If we use the tab key focus on an element and use the arrow key to focus on another element. What element we should select/de-select when pressing on enter key.

mollfpr · 2023-12-19T12:32:28Z

If we use the tab key focus on an element and use the arrow key to focus on another element. What element we should select/de-select when pressing on enter key.

In this case, the item is selected from the arrow key.

dukenv0307 · 2023-12-20T08:27:50Z

@mollfpr But the element that is focused by the tap key also triggers the onPress function when we press on enter key.

mollfpr · 2023-12-20T11:54:40Z

@dukenv0307 So we can only make it select/deselect on items that are highlighted from the tab navigation? I can't select/deselect it with the arrow key, even if it doesn't have a pressable element highlighted.

dukenv0307 · 2023-12-25T09:43:33Z

@mollfpr Actually, if we don't have a pressable element highlighted the form will be submitted by pressOnEnter prop of confirm button.

mollfpr · 2023-12-28T14:05:22Z

Actually, if we don't have a pressable element highlighted the form will be submitted by pressOnEnter prop of confirm button.

This should be fine.

Screen.Recording.2023-12-28.at.21.01.19.mp4

There are still some issues that occurred on my test.

~~The member is not selected while choosing it with the arrow key~~ I found it working the way it is in the production, so this shouldn't be a problem here.
Selecting the member with tab key make it select and deselect

dukenv0307 · 2024-01-03T07:28:43Z

Selecting the member with tab key make it select and deselect

@mollfpr Updated to fix this case

mollfpr

@dukenv0307 I don't find the different result between this PR and current staging. Do you mind explain with changes?

mollfpr · 2024-01-03T15:00:35Z

+    }
+
+    subscribeActiveElement() {
+        if (![CONST.PLATFORM.DESKTOP, CONST.PLATFORM.WEB].includes(getPlatform())) {


I think we can make ![CONST.PLATFORM.DESKTOP, CONST.PLATFORM.WEB].includes(getPlatform()) this a variable and use it in unSubscribeActiveElement

dukenv0307 · 2024-01-04T09:48:45Z

In staging, if we focus by tab key in a option and focus by arrow key in the same option it will be select/de-select immediately. And in this PR we fixed this issue

Screen.Recording.2024-01-04.at.16.47.10.mov

mollfpr · 2024-01-04T15:19:51Z

Okay, I see the difference, but I still don't understand why disableEnterShortCut and the listener function is fixing the issue. @dukenv0307 Do you mind explaining it a bit more?

mollfpr · 2024-01-09T12:14:04Z

this will make the shortcut cmd+enter or ctrl+enter to submit the selection not work.

@dukenv0307 What about the above issue?

dukenv0307 · 2024-01-09T12:15:55Z

We can fix this easily by only disable enter short cut.

mollfpr · 2024-01-09T12:16:55Z

Okay, let's do that!

mollfpr

LGTM 👍

mollfpr · 2024-01-10T05:18:56Z

Whoops, we have a conflict. @dukenv0307 Could you resolve it? Thanks!

mollfpr

It still looks good and tests well! Although the cmd+enter is not working, checking the staging, it's also happening, so the regression is not from this PR.

joelbettner · 2024-01-12T00:39:39Z

@dukenv0307 It looks good to be, but I'm really not sure what is going on with the failed TypeScript Check.

dukenv0307 · 2024-01-12T04:10:47Z

@joelbettner Fixed.

OSBotify · 2024-01-12T18:25:32Z

✋ 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 · 2024-01-15T11:56:44Z

🚀 Deployed to staging by https://github.com/joelbettner in version: 1.4.25-0 🚀

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

OSBotify · 2024-01-17T01:14:28Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.25-10 🚀

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

aimane-chnaif · 2024-02-21T21:17:31Z

+        if (prevState.disableEnterShortCut !== this.state.disableEnterShortCut) {
+            if (this.state.disableEnterShortCut) {
+                this.unsubscribeEnter();
+            } else {
+                this.subscribeToEnterShortcut();


This caused regression of enter key sometimes not working while navigating - #35373
More details about the root cause: #35373 (comment)

Caused similar regression where enter key not working while saving ws name #36923

dukenv0307 added 3 commits December 4, 2023 15:08

prevent enter key subscribe

6840985

check checkbox only

31109b8

fix lint

721729f

dukenv0307 marked this pull request as ready for review December 5, 2023 04:05

dukenv0307 requested a review from a team as a code owner December 5, 2023 04:05

melvin-bot Bot requested review from mollfpr and removed request for a team December 5, 2023 04:05

dukenv0307 added 2 commits December 7, 2023 11:32

Merge branch 'main' into fix/21392

0fea640

fix focus for element

3d3964a

mollfpr reviewed Dec 18, 2023

View reviewed changes

bernhardoj mentioned this pull request Dec 23, 2023

[HOLD for payment 2024-06-11] [$1000] Web - Three dot menu is not opened via Enter key in Request Money to Add Receipt #33502

Closed

6 tasks

merge main

642ee58

dukenv0307 added 2 commits January 3, 2024 13:42

Merge branch 'main' into fix/21392

9cbbd29

change role of circle icon in OptionRow

11ffb05

mollfpr reviewed Jan 3, 2024

View reviewed changes

dukenv0307 added 2 commits January 9, 2024 19:41

only disable enter short cut

0b9f6df

Merge branch 'main' into fix/21392

b1b29b7

mollfpr approved these changes Jan 10, 2024

View reviewed changes

melvin-bot Bot requested a review from joelbettner January 10, 2024 05:18

dukenv0307 added 2 commits January 10, 2024 12:46

merge main

654e4ed

revert hard code

db089da

mollfpr approved these changes Jan 10, 2024

View reviewed changes

dukenv0307 added 3 commits January 11, 2024 11:36

merge main

a6c1687

Merge branch 'main' of https://github.com/dukenv0307/App into fix/21392

3b93bf2

Merge branch 'main' into fix/21392

fe22006

joelbettner approved these changes Jan 12, 2024

View reviewed changes

Merge branch 'main' into fix/21392

2d77f12

joelbettner merged commit ca4d938 into Expensify:main Jan 12, 2024

github-actions Bot mentioned this pull request Jan 15, 2024

Deploy Checklist: New Expensify 2024-01-15 #34493

Closed

83 tasks

melvin-bot Bot mentioned this pull request Jan 17, 2024

[C+ Checklist Needs Completion] [$1000] Keyboard navigation and selection is inconsistent in Split Bill UI #21392

Closed

6 tasks

bernhardoj mentioned this pull request Jan 19, 2024

[$500] Tag - "Show more" button does not expand the list when clicked on #34761

Closed

6 tasks

This was referenced Feb 13, 2024

[HOLD for payment 2024-02-20] [$500] The "Enter" key does not work when editing the "Description" and "Merchant" fields #36370

Closed

[CP Staging] Fix listener in options selector #36396

Merged

aimane-chnaif reviewed Feb 21, 2024

View reviewed changes

aimane-chnaif mentioned this pull request Feb 21, 2024

[HOLD for payment 2024-02-26] [$500] Cursor don't move to next line if return button tapped on keypad after back from referral #35373

Closed

6 tasks

getusha mentioned this pull request Mar 12, 2024

[HOLD for payment 2024-03-13] [$500] Workspace – Unable to save edited WS name using Enter key in newly created WS. #36923

Closed

6 tasks

Uh oh!

Conversation

dukenv0307 commented Dec 5, 2023 • 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 Dec 5, 2023

Uh oh!

dukenv0307 commented Dec 5, 2023

Uh oh!

mollfpr commented Dec 6, 2023

Uh oh!

dukenv0307 commented Dec 6, 2023

Uh oh!

dukenv0307 commented Dec 7, 2023

Uh oh!

mollfpr commented Dec 14, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

mollfpr left a comment

Choose a reason for hiding this comment

Uh oh!

mollfpr Dec 16, 2023

Choose a reason for hiding this comment

Uh oh!

dukenv0307 commented Dec 18, 2023

Uh oh!

mollfpr commented Dec 19, 2023

Uh oh!

dukenv0307 commented Dec 20, 2023

Uh oh!

mollfpr commented Dec 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dukenv0307 commented Dec 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mollfpr commented Dec 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dukenv0307 commented Jan 3, 2024

Uh oh!

mollfpr left a comment

Choose a reason for hiding this comment

Uh oh!

mollfpr Jan 3, 2024

Choose a reason for hiding this comment

Uh oh!

dukenv0307 commented Jan 4, 2024

Uh oh!

mollfpr commented Jan 4, 2024

Uh oh!

mollfpr commented Jan 9, 2024

Uh oh!

dukenv0307 commented Jan 9, 2024

Uh oh!

mollfpr commented Jan 9, 2024

Uh oh!

mollfpr left a comment

Choose a reason for hiding this comment

Uh oh!

mollfpr commented Jan 10, 2024

Uh oh!

mollfpr left a comment

Choose a reason for hiding this comment

Uh oh!

joelbettner commented Jan 12, 2024

Uh oh!

dukenv0307 commented Jan 12, 2024

Uh oh!

OSBotify commented Jan 12, 2024

Uh oh!

dukenv0307 commented Dec 5, 2023 •

edited

Loading

mollfpr commented Dec 14, 2023 •

edited

Loading

mollfpr commented Dec 20, 2023 •

edited

Loading

dukenv0307 commented Dec 25, 2023 •

edited

Loading

mollfpr commented Dec 28, 2023 •

edited

Loading