Fix pressing enter doesn't select the emoji category #50971

bernhardoj · 2024-10-17T07:16:17Z

Details

Pressing ENTER doesn't select the emoji category in emoji picker.

Fixed Issues

$ #50561
PROPOSAL: #50561 (comment)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Open any chat
Press the emoji picker
Type any character on the search and then remove it
Press TAB to focus on the emoji category
Press ENTER
Verify the emoji picker is scrolled to the pressed category

iOS: no keyboard shortcut
Android: no keyboard shortcut either, but it natively supports it

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: 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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.mp4

Android: mWeb Chrome

android.mweb.mp4

iOS: Native

iOS: mWeb Safari

ios.mweb.mp4

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

melvin-bot · 2024-10-17T07:16:22Z

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

ahmedGaber93 · 2024-10-17T22:39:35Z

src/components/EmojiPicker/EmojiPickerMenu/index.tsx

-            if (!isEnterWhileComposition(keyBoardEvent) && keyBoardEvent.key === CONST.KEYBOARD_SHORTCUTS.ENTER.shortcutKey) {
-                // On web, avoid this Enter default input action; otherwise, it will add a new line in the subsequently focused composer.
-                keyBoardEvent.preventDefault();
-                // On mWeb, avoid propagating this Enter keystroke to Pressable child component; otherwise, it will trigger the onEmojiSelected callback again.
-                keyBoardEvent.stopPropagation();
-                return;
-            }


Why you remove the whole condition, Shouldn't we keep the return early here?

I removed it because it won't affect the code below it.

App/src/components/EmojiPicker/EmojiPickerMenu/index.tsx

Lines 150 to 161 in c3d33fc

// Enable keyboard movement if tab or enter is pressed or if shift is pressed while the input

// is not focused, so that the navigation and tab cycling can be done using the keyboard without

// interfering with the input behaviour.

if (keyBoardEvent.key === 'Tab' || keyBoardEvent.key === 'Enter' || (keyBoardEvent.key === 'Shift' && searchInputRef.current && !isTextInputFocused(searchInputRef))) {

setIsUsingKeyboardMovement(true);

}

// We allow typing in the search box if any key is pressed apart from Arrow keys.

if (searchInputRef.current && !isTextInputFocused(searchInputRef) && ReportUtils.shouldAutoFocusOnKeyPress(keyBoardEvent)) {

searchInputRef.current.focus();

}

},

For

App/src/components/EmojiPicker/EmojiPickerMenu/index.tsx

Lines 157 to 160 in c3d33fc

// We allow typing in the search box if any key is pressed apart from Arrow keys.

if (searchInputRef.current && !isTextInputFocused(searchInputRef) && ReportUtils.shouldAutoFocusOnKeyPress(keyBoardEvent)) {

searchInputRef.current.focus();

}

it's only executed if shouldAutoFocusOnKeyPress is true which is false for ENTER.

App/src/libs/ReportUtils.ts

Lines 7595 to 7598 in c3d33fc

function shouldAutoFocusOnKeyPress(event: KeyboardEvent): boolean {

if (event.key.length > 1) {

return false;

}

For

App/src/components/EmojiPicker/EmojiPickerMenu/index.tsx

Lines 150 to 155 in c3d33fc

// Enable keyboard movement if tab or enter is pressed or if shift is pressed while the input

// is not focused, so that the navigation and tab cycling can be done using the keyboard without

// interfering with the input behaviour.

if (keyBoardEvent.key === 'Tab' || keyBoardEvent.key === 'Enter' || (keyBoardEvent.key === 'Shift' && searchInputRef.current && !isTextInputFocused(searchInputRef))) {

setIsUsingKeyboardMovement(true);

}

the keyboard movement state is used to show the focused state of emoji item.

App/src/components/EmojiPicker/EmojiPickerMenu/index.tsx

Line 271 in c3d33fc

const isEmojiFocused = index === focusedIndex && isUsingKeyboardMovement;

The emoji will be focused when we use arrow key, tab, or hold down mouse on it. The time we press Enter, the emoji will be selected. From my understanding, the isUsingKeyboardMovement state is used to not show the blue outline on the emoji when focused using mouse.

But it will still show anyway with the mouse because when focused, we update the focused index.

App/src/components/EmojiPicker/EmojiPickerMenu/index.tsx

Line 293 in c3d33fc

onFocus={() => setFocusedIndex(index)}

which always update isUsingKeyboardMovement to true.

App/src/components/EmojiPicker/EmojiPickerMenu/index.tsx

Lines 75 to 87 in c3d33fc

const onFocusedIndexChange = useCallback(

(newIndex: number) => {

if (filteredEmojis.length === 0) {

return;

}

if (highlightFirstEmoji) {

setHighlightFirstEmoji(false);

}

if (!isUsingKeyboardMovement) {

setIsUsingKeyboardMovement(true);

}

We can remove Enter from the if if you want.

App/src/components/EmojiPicker/EmojiPickerMenu/index.tsx

Line 153 in c3d33fc

if (keyBoardEvent.key === 'Tab' || keyBoardEvent.key === 'Enter' || (keyBoardEvent.key === 'Shift' && searchInputRef.current && !isTextInputFocused(searchInputRef))) {

We can remove Enter from the if if you want.

To be honest, I don't understand what is the purpose of keyBoardEvent.key === 'Enter' ||, As I see in the code clicking Enter should do one of

select the emoji and close the menu

select the category

In the both cases this condition keyBoardEvent.key === 'Enter' || it is not reachable in the old code here, and beside your explanation about isUsingKeyboardMovement it seems to don't do any function but let's know what @aldo-expensify think before remove it

In the both cases this condition keyBoardEvent.key === 'Enter' || it is not reachable in the old code here

Yeah, good point.

Sorry for the delay here, I'm just starting to look at this 👁️

I'm very unfamiliar with the details here, and I'm wanting to avoid spending to much time to understand all the details around it. I tested and it appears to be working well for me, so I'm going to just assume that we don't need to change anything here since it is working.

ahmedGaber93 · 2024-10-18T19:35:42Z

Bug: the first emoji on the selected category is not autofocused after selecting the category like what we do in search emoji.

Open emoji menu
Use tab then Ener to select any category
Try to select the emoji by the keyboard arrows

Expected: after selecting any category, first emoji of it should be focused and arrow-left and arrow-right should move focusing between category emojis.

Current: the first emoji on the selected category is not autofocused after selecting the category and arrow-left and arrow-right do nothing (instead the first emoji on the first category not the selected category is focused)

20241018122154891.mp4

I think this feature is not broken, but it is not implemented before.

bernhardoj · 2024-10-19T03:56:06Z

I think this feature is not broken, but it is not implemented before.

Yes, it was never implemented, so it's not a bug.

ahmedGaber93 · 2024-10-21T15:55:57Z

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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

a.mp4

Android: mWeb Chrome

aw.mp4

iOS: Native

i.mp4

iOS: mWeb Safari

iw.mp4

MacOS: Chrome / Safari

w.mp4

MacOS: Desktop

d.mp4

ahmedGaber93

LGTM! Just need a confirmation here #50971 (comment)

ahmedGaber93 · 2024-10-21T16:02:10Z

I will report this bug #50971 (comment) in slack after deploying this PR to staging

aldo-expensify · 2024-10-23T23:59:29Z

So, I've testing this and this seems to be pretty important: #50971 (comment)

Once you select a category using the keyboard, it is not possible to choose emojis properly unless we go with the mouse. Then, being able to scroll by hitting enter on the category becomes somewhat pointless if your intention was to navigate with the keyboard.

I'm inclined to consider this as part of the scope of the work being done here.

trjExpensify · 2024-10-24T00:07:48Z

Makes sense to me. 👍

…button

bernhardoj · 2024-10-24T05:51:29Z

I'm inclined to consider this as part of the scope of the work being done here.

It feels more like a missing feature, luckily it's very simple to do. Here is how it looks

web.mp4

aldo-expensify · 2024-10-25T19:35:48Z

luckily it's very simple to do. Here is how it looks

Thank you @bernhardoj , it works pretty well now.

Screen.Recording.2024-10-25.at.12.33.04.PM.mov

It feels more like a missing feature,

If you are hinting there should be extra compensation, feel free to request in the right channel (I'm not sure which one is the right channel :) )

OSBotify · 2024-10-25T19:47:55Z

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

github-actions · 2024-10-29T09:44:25Z

🚀 Deployed to staging by https://github.com/aldo-expensify in version: 9.0.55-0 🚀

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

github-actions · 2024-10-31T11:17:37Z

🚀 Deployed to production by https://github.com/Beamanator in version: 9.0.55-10 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	skipped 🚫
🍎🔄 iOS HybridApp 🍎🔄	skipped 🚫

fix pressing enter doesn't select the emoji category

9c1bd32

bernhardoj requested a review from a team as a code owner October 17, 2024 07:16

melvin-bot bot requested a review from ahmedGaber93 October 17, 2024 07:16

melvin-bot bot removed the request for review from a team October 17, 2024 07:16

ahmedGaber93 reviewed Oct 17, 2024

View reviewed changes

ahmedGaber93 approved these changes Oct 21, 2024

View reviewed changes

melvin-bot bot requested a review from aldo-expensify October 21, 2024 16:00

aldo-expensify mentioned this pull request Oct 24, 2024

[HOLD for payment 2024-11-07] [$250] Web/Desktop - Emoji Picker - Nothing happens when user press "Enter" on emoji category icon #50561

Closed

6 tasks

bernhardoj added 3 commits October 24, 2024 13:38

Merge branch 'main' into fix/50561-enter-doesnt-press-emoji-category-…

9a4742d

…button

set the header as focused index

8cd287d

remove console

668973c

aldo-expensify approved these changes Oct 25, 2024

View reviewed changes

aldo-expensify merged commit 44c9260 into Expensify:main Oct 25, 2024
17 checks passed

github-actions bot mentioned this pull request Oct 29, 2024

Deploy Checklist: New Expensify 2024-10-29 #51635

Closed

65 tasks

ahmedGaber93 mentioned this pull request Nov 6, 2024

fix: clicking enter on emoji selector for status results in leaving status pane. #47761

Merged

50 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix pressing enter doesn't select the emoji category #50971

Fix pressing enter doesn't select the emoji category #50971

bernhardoj commented Oct 17, 2024 •

edited

Loading

melvin-bot bot commented Oct 17, 2024

ahmedGaber93 Oct 17, 2024

bernhardoj Oct 18, 2024

ahmedGaber93 Oct 18, 2024

bernhardoj Oct 19, 2024

aldo-expensify Oct 23, 2024

aldo-expensify Oct 25, 2024

ahmedGaber93 commented Oct 18, 2024 •

edited

Loading

bernhardoj commented Oct 19, 2024

ahmedGaber93 commented Oct 21, 2024

ahmedGaber93 left a comment

ahmedGaber93 commented Oct 21, 2024

aldo-expensify commented Oct 23, 2024

trjExpensify commented Oct 24, 2024

bernhardoj commented Oct 24, 2024

aldo-expensify commented Oct 25, 2024

OSBotify commented Oct 25, 2024

github-actions bot commented Oct 29, 2024

github-actions bot commented Oct 31, 2024

	// Enable keyboard movement if tab or enter is pressed or if shift is pressed while the input
	// is not focused, so that the navigation and tab cycling can be done using the keyboard without
	// interfering with the input behaviour.
	if (keyBoardEvent.key === 'Tab' \|\| keyBoardEvent.key === 'Enter' \|\| (keyBoardEvent.key === 'Shift' && searchInputRef.current && !isTextInputFocused(searchInputRef))) {
	setIsUsingKeyboardMovement(true);
	}

	// We allow typing in the search box if any key is pressed apart from Arrow keys.
	if (searchInputRef.current && !isTextInputFocused(searchInputRef) && ReportUtils.shouldAutoFocusOnKeyPress(keyBoardEvent)) {
	searchInputRef.current.focus();
	}
	},

	function shouldAutoFocusOnKeyPress(event: KeyboardEvent): boolean {
	if (event.key.length > 1) {
	return false;
	}

	const onFocusedIndexChange = useCallback(
	(newIndex: number) => {
	if (filteredEmojis.length === 0) {
	return;
	}

	if (highlightFirstEmoji) {
	setHighlightFirstEmoji(false);
	}

	if (!isUsingKeyboardMovement) {
	setIsUsingKeyboardMovement(true);
	}

Fix pressing enter doesn't select the emoji category #50971

Fix pressing enter doesn't select the emoji category #50971

Conversation

bernhardoj commented Oct 17, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 17, 2024

ahmedGaber93 Oct 17, 2024

Choose a reason for hiding this comment

bernhardoj Oct 18, 2024

Choose a reason for hiding this comment

ahmedGaber93 Oct 18, 2024

Choose a reason for hiding this comment

bernhardoj Oct 19, 2024

Choose a reason for hiding this comment

aldo-expensify Oct 23, 2024

Choose a reason for hiding this comment

aldo-expensify Oct 25, 2024

Choose a reason for hiding this comment

ahmedGaber93 commented Oct 18, 2024 • edited Loading

bernhardoj commented Oct 19, 2024

ahmedGaber93 commented Oct 21, 2024

Reviewer Checklist

Screenshots/Videos

ahmedGaber93 left a comment

Choose a reason for hiding this comment

ahmedGaber93 commented Oct 21, 2024

aldo-expensify commented Oct 23, 2024

trjExpensify commented Oct 24, 2024

bernhardoj commented Oct 24, 2024

aldo-expensify commented Oct 25, 2024

OSBotify commented Oct 25, 2024

github-actions bot commented Oct 29, 2024

github-actions bot commented Oct 31, 2024

bernhardoj commented Oct 17, 2024 •

edited

Loading

ahmedGaber93 commented Oct 18, 2024 •

edited

Loading