Add shouldSyncFocus prop to ListItem components #40234

WojtekBoman · 2024-04-15T12:15:32Z

cc: @roryabraham

Details

This PR fixes an issue with losing focus on the text input after typing a letter in SelectionList components.

For example:

Screen.Recording.2024-04-15.at.14.22.15.mov

Fixed Issues

$ #39201 (comment)
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Create a new money request.
Type any amount of money and proceed.
Type any letter, wait until the focus is on the first item on the list and check that you can continue typing.

Offline tests

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-04-15.at.17.05.29.mov

Android: mWeb Chrome

Screen.Recording.2024-04-15.at.17.00.36.mov

iOS: Native

Screen.Recording.2024-04-15.at.18.06.46.mov

iOS: mWeb Safari

Screen.Recording.2024-04-15.at.17.33.54.mov

MacOS: Chrome / Safari

Screen.Recording.2024-04-15.at.16.54.14.mov

MacOS: Desktop

Screen.Recording.2024-04-15.at.16.48.47.mov

Kicu

Seems legit to me - it fixes the problem. I left you small comments

Kicu · 2024-04-15T13:09:27Z

src/components/SelectionList/UserListItem.tsx

@@ -67,6 +69,8 @@ function UserListItem({
                ) : undefined
            }
            keyForList={item.keyForList}
+            onFocus={onFocus}


Im not sure what this onFocus is doing?

Kicu · 2024-04-15T13:11:51Z

src/components/SelectionList/BaseListItem.tsx

@@ -37,7 +38,7 @@ function BaseListItem<TItem extends ListItem>({
    const pressableRef = useRef<View | HTMLDivElement>(null);

    // Sync focus on an item
-    useSyncFocus(pressableRef, Boolean(isFocused));
+    useSyncFocus(pressableRef, Boolean(isFocused && !shouldPreventFocusSync));


This name is a bit much to parse 😅 I suggest to remove the prevent from name, so that name stays positive - describing what it does, and not negated - which means I need to think more...

First we name it "prevent" but then we have to run ! before it.

I suggest to use a simpler shouldSyncFocus name to use everywhere

melvin-bot · 2024-04-15T16:13:30Z

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

roryabraham · 2024-04-15T21:34:01Z

requesting C+ review from @fedirjh since this fixes a regression from #39201

roryabraham

code LGTM pending C+ review

fedirjh · 2024-04-16T05:49:50Z

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

CleanShot.2024-04-17.at.03.32.47.mp4

Android: mWeb Chrome

CleanShot.2024-04-16.at.15.08.45.mp4

iOS: Native

CleanShot.2024-04-16.at.06.56.21.mp4

iOS: mWeb Safari

CleanShot.2024-04-16.at.06.59.59.mp4

MacOS: Chrome / Safari

CleanShot.2024-04-16.at.06.12.02.mp4

MacOS: Desktop

CleanShot.2024-04-16.at.06.19.23.mp4

lakchote · 2024-04-16T07:59:51Z

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

roryabraham · 2024-04-16T16:36:38Z

helping @fedirjh debug android native build: https://expensify.slack.com/archives/C01GTK53T8Q/p1713282847932119

roryabraham · 2024-04-16T22:48:09Z

@WojtekBoman there are conflicts to resolve here

fedirjh

Looks good and tests well.

melvin-bot · 2024-04-17T02:57:30Z

🎯 @fedirjh, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #40329.

WojtekBoman · 2024-04-17T06:59:25Z

@WojtekBoman there are conflicts to resolve here

Conflicts resolved :)

OSBotify · 2024-04-18T01:00:28Z

✋ 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-04-18T05:00:56Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.4.63-0 🚀

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

OSBotify · 2024-04-22T15:01:55Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.63-21 🚀

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

Add shouldPreventFocusSync prop to ListItem components

90f219b

Kicu approved these changes Apr 15, 2024

View reviewed changes

WojtekBoman added 2 commits April 15, 2024 17:42

Rename shouldPreventFocusSync to shouldSyncFocus

fa118b6

Merge branch 'main' into fix/focus-sync-selection-list

a26ee23

WojtekBoman changed the title ~~Add shouldPreventFocusSync prop to ListItem components~~ Add shouldSyncFocus prop to ListItem components Apr 15, 2024

WojtekBoman mentioned this pull request Apr 15, 2024

Sync keyboard navigation in SelectionList and PopoverMenu #39201

Merged

50 tasks

WojtekBoman marked this pull request as ready for review April 15, 2024 16:13

WojtekBoman requested a review from a team as a code owner April 15, 2024 16:13

melvin-bot bot removed the request for review from a team April 15, 2024 16:13

melvin-bot bot requested a review from lakchote April 15, 2024 16:13

roryabraham requested a review from fedirjh April 15, 2024 21:34

roryabraham previously approved these changes Apr 15, 2024

View reviewed changes

lakchote previously approved these changes Apr 16, 2024

View reviewed changes

Merge branch 'main' into fix/focus-sync-selection-list

8321b44

fedirjh approved these changes Apr 17, 2024

View reviewed changes

melvin-bot bot mentioned this pull request Apr 17, 2024

Payment issue for E/App PR#40234 #40329

Closed

Merge branch 'main' into fix/focus-sync-selection-list

9db05c7

WojtekBoman dismissed stale reviews from lakchote and roryabraham via 9db05c7 April 17, 2024 06:35

WojtekBoman mentioned this pull request Apr 17, 2024

Migrate search page to chat finder page #40129

Merged

50 tasks

roryabraham approved these changes Apr 18, 2024

View reviewed changes

roryabraham merged commit a573219 into Expensify:main Apr 18, 2024
17 checks passed

github-actions bot mentioned this pull request Apr 18, 2024

Deploy Checklist: New Expensify 2024-04-18 #40392

Closed

fedirjh mentioned this pull request Apr 19, 2024

[$250] Tag - Tag list scrolls up when selecting a tag from the list #40410

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add shouldSyncFocus prop to ListItem components #40234

Add shouldSyncFocus prop to ListItem components #40234

WojtekBoman commented Apr 15, 2024 •

edited

Loading

Kicu left a comment

Kicu Apr 15, 2024

Kicu Apr 15, 2024

melvin-bot bot commented Apr 15, 2024

roryabraham commented Apr 15, 2024

roryabraham left a comment

fedirjh commented Apr 16, 2024 •

edited

Loading

lakchote commented Apr 16, 2024 •

edited

Loading

roryabraham commented Apr 16, 2024

roryabraham commented Apr 16, 2024

fedirjh left a comment

melvin-bot bot commented Apr 17, 2024

WojtekBoman commented Apr 17, 2024

OSBotify commented Apr 18, 2024

OSBotify commented Apr 18, 2024

OSBotify commented Apr 22, 2024

Add shouldSyncFocus prop to ListItem components #40234

Add shouldSyncFocus prop to ListItem components #40234

Conversation

WojtekBoman commented Apr 15, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Kicu left a comment

Choose a reason for hiding this comment

Kicu Apr 15, 2024

Choose a reason for hiding this comment

Kicu Apr 15, 2024

Choose a reason for hiding this comment

melvin-bot bot commented Apr 15, 2024

roryabraham commented Apr 15, 2024

roryabraham left a comment

Choose a reason for hiding this comment

fedirjh commented Apr 16, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

lakchote commented Apr 16, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

roryabraham commented Apr 16, 2024

roryabraham commented Apr 16, 2024

fedirjh left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Apr 17, 2024

WojtekBoman commented Apr 17, 2024

OSBotify commented Apr 18, 2024

OSBotify commented Apr 18, 2024

OSBotify commented Apr 22, 2024

WojtekBoman commented Apr 15, 2024 •

edited

Loading

fedirjh commented Apr 16, 2024 •

edited

Loading

lakchote commented Apr 16, 2024 •

edited

Loading