Prevent enter key event of button if the focused element is clickable #32549

dukenv0307 · 2023-12-06T09:05:38Z

Details

Prevent enter key event of button if the focused element is clickable

Fixed Issues

$ #32294
PROPOSAL: #32294 (comment)

Tests

Create a new workspace
Change the default currency of the workspace if it's USD
Click on Bank account
When confirm modal appear, press the tab key to focus on the Cancel button
Press the enter key and verify that the modal is closed and we do not go to ReimbursementAccountPage

Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Create a new workspace
Change the default currency of the workspace if it's USD
Click on Bank account
When confirm modal appear, press the tab key to focus on the Cancel button
Press the enter key and verify that the modal is closed and we do not go to ReimbursementAccountPage

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2023-12-06.at.15.53.29.mov

Android: mWeb Chrome

Screen.Recording.2023-12-06.at.15.37.05.mov

iOS: Native

Screen.Recording.2023-12-06.at.15.55.05.mov

iOS: mWeb Safari

Screen.Recording.2023-12-06.at.15.28.08.mov

MacOS: Chrome / Safari

Screen.Recording.2023-12-06.at.15.22.42.mov

MacOS: Desktop

Screen.Recording.2023-12-06.at.16.00.07.mov

melvin-bot · 2023-12-06T09:14:58Z

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

ArekChr · 2023-12-06T10:20:45Z

src/components/Button/index.tsx

+    const roles: string[] = Object.values(CONST.ACCESSIBILITY_ROLE);
+    const shouldDisableEnterShortcut = roles.includes(activeElement?.role ?? '') && activeElement?.role !== CONST.ACCESSIBILITY_ROLE.TEXT;


The name of const roles is confusing. Let's rename it to accessibilityRoles or remove it like the below

Suggested change

const roles: string[] = Object.values(CONST.ACCESSIBILITY_ROLE);

const shouldDisableEnterShortcut = roles.includes(activeElement?.role ?? '') && activeElement?.role !== CONST.ACCESSIBILITY_ROLE.TEXT;

const shouldDisableEnterShortcut = Object.values(CONST.ACCESSIBILITY_ROLE).includes(activeElement?.role ?? '') && activeElement?.role !== CONST.ACCESSIBILITY_ROLE.TEXT;

Object.values(CONST.ACCESSIBILITY_ROLE).includes(activeElement?.role ?? '') && activeElement?.role !== CONST.ACCESSIBILITY_ROLE.TEXT;

@ArekChr This update will have ts error so renamed variable

ArekChr · 2023-12-06T10:22:30Z

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 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

android.mov

Android: mWeb Chrome

android.web.chrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

ios.web.safari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

ArekChr

All works! Thanks for PR

mountiny

Thanks!

OSBotify · 2023-12-06T11:33: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 · 2023-12-06T22:19:16Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.9-0 🚀

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

OSBotify · 2023-12-06T23:13:27Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.9-0 🚀

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

OSBotify · 2023-12-08T01:10:33Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.4.9-5 🚀

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

dukenv0307 added 2 commits December 6, 2023 15:56

prevent enter key event of button if the focused element is clickable

85ef36e

fix lint

c9c2205

dukenv0307 marked this pull request as ready for review December 6, 2023 09:14

dukenv0307 requested a review from a team as a code owner December 6, 2023 09:14

melvin-bot bot requested review from ArekChr and removed request for a team December 6, 2023 09:14

ArekChr reviewed Dec 6, 2023

View reviewed changes

rename variables

4444e62

ArekChr approved these changes Dec 6, 2023

View reviewed changes

melvin-bot bot requested a review from mountiny December 6, 2023 10:33

mountiny assigned dukenv0307 Dec 6, 2023

mountiny approved these changes Dec 6, 2023

View reviewed changes

mountiny merged commit 403182a into Expensify:main Dec 6, 2023
17 checks passed

github-actions bot mentioned this pull request Dec 6, 2023

Deploy Checklist: New Expensify 2023-12-06 #32589

Closed

74 tasks

melvin-bot bot mentioned this pull request Dec 8, 2023

[HOLD for payment 2023-12-15] [$500] Web - Workspace - Selecting Cancel and pressing Enter key via keyboard updates default currency to USD #32294

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Prevent enter key event of button if the focused element is clickable #32549

Prevent enter key event of button if the focused element is clickable #32549

dukenv0307 commented Dec 6, 2023

melvin-bot bot commented Dec 6, 2023

ArekChr Dec 6, 2023 •

edited

Loading

dukenv0307 Dec 6, 2023 •

edited

Loading

ArekChr commented Dec 6, 2023

ArekChr left a comment

mountiny left a comment

OSBotify commented Dec 6, 2023

OSBotify commented Dec 6, 2023

OSBotify commented Dec 6, 2023

OSBotify commented Dec 8, 2023

		const roles: string[] = Object.values(CONST.ACCESSIBILITY_ROLE);
		const shouldDisableEnterShortcut = roles.includes(activeElement?.role ?? '') && activeElement?.role !== CONST.ACCESSIBILITY_ROLE.TEXT;

	const roles: string[] = Object.values(CONST.ACCESSIBILITY_ROLE);
	const shouldDisableEnterShortcut = roles.includes(activeElement?.role ?? '') && activeElement?.role !== CONST.ACCESSIBILITY_ROLE.TEXT;
	const shouldDisableEnterShortcut = Object.values(CONST.ACCESSIBILITY_ROLE).includes(activeElement?.role ?? '') && activeElement?.role !== CONST.ACCESSIBILITY_ROLE.TEXT;

Prevent enter key event of button if the focused element is clickable #32549

Prevent enter key event of button if the focused element is clickable #32549

Conversation

dukenv0307 commented Dec 6, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 6, 2023

ArekChr Dec 6, 2023 • edited Loading

Choose a reason for hiding this comment

dukenv0307 Dec 6, 2023 • edited Loading

Choose a reason for hiding this comment

ArekChr commented Dec 6, 2023

Reviewer Checklist

Screenshots/Videos

ArekChr left a comment

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Dec 6, 2023

OSBotify commented Dec 6, 2023

OSBotify commented Dec 6, 2023

OSBotify commented Dec 8, 2023

ArekChr Dec 6, 2023 •

edited

Loading

dukenv0307 Dec 6, 2023 •

edited

Loading