fix(selection-list): highlight on lists with 1 section #27246

thiagobrez · 2023-09-12T12:21:53Z

Details

On lists with only 1 section, after selecting one item in the list, the next available item was being focused.

Simplified the logic to do nothing in this case.

Fixed Issues

$ #25884
PROPOSAL:

Tests

Verify that no errors appear in the JS console

In Workspace -> Members (multiple-selection list with only 1 section):

Selecting or de-selecting an item should maintain the highlight in the same item

In Workspace -> Members -> Invite (multiple-selection list with multiple sections), nothing is changed. Selected items are moved to the top, and highlight goes to the first un-selected item.

Offline tests

QA Steps

Verify that no errors appear in the JS console

In Workspace -> Members (multiple-selection list with only 1 section):

Selecting or de-selecting an item should maintain the highlight in the same item

In Workspace -> Members -> Invite (multiple-selection list with multiple sections), nothing is changed. Selected items are moved to the top, and highlight goes to the first un-selected item.

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 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 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

web.mov

Mobile Web - Chrome

android.web.mov

Mobile Web - Safari

ios.web.mp4

Desktop

desktop.mov

iOS

ios.native.mp4

Android

android.native.mov

src/components/SelectionList/BaseSelectionList.js

melvin-bot · 2023-09-12T14:03:12Z

@shawnborton @allroundexperts 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]

thiagobrez · 2023-09-12T14:04:00Z

Pinging @Santhosh-Sellavel here because he reviewed all the other SelectionList refactor PRs

allroundexperts · 2023-09-12T14:04:33Z

@thiagobrez @Santhosh-Sellavel is OoO. I can help the review here!

thiagobrez · 2023-09-12T14:06:08Z

Awesome, thank you @allroundexperts!

For context: Shawn said here to change to this behavior

allroundexperts · 2023-09-12T14:08:49Z

Sounds good!

allroundexperts · 2023-09-12T14:36:08Z

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 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(themeColors.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

Web

Screen.Recording.2023-09-25.at.9.50.59.AM.mov

Mobile Web - Chrome

Screen.Recording.2023-09-25.at.9.52.37.AM.mov

Mobile Web - Safari

Screen.Recording.2023-09-25.at.9.57.39.AM.mov

Desktop

Screen.Recording.2023-09-25.at.10.01.00.AM.mov

iOS

Screen.Recording.2023-09-25.at.9.58.31.AM.mov

Android

Screen.Recording.2023-09-25.at.9.56.07.AM.mov

shawnborton · 2023-09-12T19:39:02Z

Looks good to me, thanks!

allroundexperts · 2023-09-12T21:46:02Z

@thiagobrez The item remains highlighted even if you un-select it. Can you please check?

Screen.Recording.2023-09-13.at.2.44.41.AM.mov

thiagobrez · 2023-09-12T21:56:55Z

Hey @allroundexperts, what is the expected behavior though?

allroundexperts · 2023-09-12T21:58:13Z

I'm not sure. But this does not look right. If you've unselected the row, the highlight should not stick. If you can confirm that this is expected, then I can continue with the review.

thiagobrez · 2023-09-12T22:07:56Z

I got you, this is new behavior and I don't have enough information to answer that. We'll need @shawnborton to check this

shawnborton · 2023-09-13T12:04:19Z

Yeah, the only highlight we want to remain is the highlight used when moving around with the arrow keys. The highlight indicates what row is active in terms of arrow navigation. And we decided that it is weird that if you check or uncheck a row that your active row would change. Basically you should not lose position of your active row as you toggle things on or off if you are using the arrow keys.

So I think @allroundexperts is right above.

thiagobrez · 2023-09-13T18:32:14Z

@shawnborton

Basically you should not lose position of your active row as you toggle things on or off if you are using the arrow keys.

Ok, so if I understand correct, while you're navigating with the keyboard, either activating or deactivating you should never loose the active row.

The problem currently is when clicking/pressing. If I click to activate, the row should get highlighted. If I click to deactivate, the highlight should disappear.

Is that how it should behave ⬆️ ?

shawnborton · 2023-09-14T02:11:18Z

I think that makes sense. Although, how does click to highlight work today?

…:thiagobrez/expensify into thiagobrez/selection-list-highlight-jump

thiagobrez · 2023-09-14T15:24:24Z

@shawnborton @allroundexperts I understand the source of confunsion now. When clicking the item, it was showing an "active" highlight, same as if you were hovering it, which is not the same as the highlight for when you're moving with the arrow keys. I removed that, which fixes what @allroundexperts mentioned above, and makes it much cleaner.

Also included in the commit a fix for the Enter hotkey event, which was not working as expected when we had accessibility selection active.

Here's a video in action:

Screen.Recording.2023-09-14.at.16.21.39.mov

shawnborton · 2023-09-15T01:31:32Z

That looks perfect, thanks!

thiagobrez · 2023-09-18T15:32:58Z

@allroundexperts Friendly reminder here

allroundexperts · 2023-09-19T19:22:28Z

On it now!

allroundexperts · 2023-09-19T19:44:25Z

This is still not working as intended. At the end of this video, notice that selecting a new row does not unselect the old one.

Screen.Recording.2023-09-20.at.12.41.09.AM.mov

Screen.Recording.2023-09-20.at.12.43.58.AM.mov

thiagobrez · 2023-09-21T14:42:16Z

@allroundexperts Ok - sent fixes, please review again!

thiagobrez · 2023-09-21T15:39:01Z

Heads up: I'll be OOO from tomorrow until Tuesday - if needed, someone from Callstack can continue here!

allroundexperts · 2023-09-21T20:29:34Z

src/components/SelectionList/BaseSelectionList.js

+ * @param {Object} item - the list item
+ * @param {Boolean} shouldUnfocusRow - flag to decide if we should unfocus all rows. True when selecting a row with click or press (not keyboard)
+ */
+ const selectRow = (item, shouldUnfocusRow = false) => {


Why defaulting shouldUnfocusRow to false when the callers always have true?

@allroundexperts The callers that pass true are the press handlers. Please search for the keyboard subscriber - there selectRow is used without the second parameter, which defaults to false

allroundexperts

Looks good!

OSBotify · 2023-09-25T12:37:41Z

✋ 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-09-28T19:20:54Z

🚀 Deployed to staging by https://github.com/cristipaval in version: 1.3.75-0 🚀

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

OSBotify · 2023-10-02T17:24:50Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.75-12 🚀

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

OSBotify · 2023-10-02T17:53:31Z

🚀 Deployed to staging by https://github.com/cristipaval in version: 1.3.76-0 🚀

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

OSBotify · 2023-10-03T15:54:28Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.76-6 🚀

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

fix(selection-list): highlight on lists with 1 section

34760eb

gedu reviewed Sep 12, 2023

View reviewed changes

src/components/SelectionList/BaseSelectionList.js Outdated Show resolved Hide resolved

gedu reviewed Sep 12, 2023

View reviewed changes

src/components/SelectionList/BaseSelectionList.js Outdated Show resolved Hide resolved

chore: make function call concise

67c2a5f

thiagobrez marked this pull request as ready for review September 12, 2023 14:03

thiagobrez requested a review from a team as a code owner September 12, 2023 14:03

melvin-bot bot requested review from allroundexperts and shawnborton and removed request for a team September 12, 2023 14:03

thiagobrez mentioned this pull request Sep 12, 2023

[HOLD for payment 2023-10-09] Member - Green highlight on member jumps to other member when selecting member #25884

Closed

6 tasks

thiagobrez added 4 commits September 14, 2023 10:48

Merge branch 'main' into thiagobrez/selection-list-highlight-jump

777ac3e

fix(selection-list): remove active item highlight

cc0c7e2

fix(selection-list): remove active item highlight

a8cc185

Merge branch 'thiagobrez/selection-list-highlight-jump' of github.com…

dcdf411

…:thiagobrez/expensify into thiagobrez/selection-list-highlight-jump

This was referenced Sep 15, 2023

LOW: [$500] Selection List Refactor: Simple Selection List #20354

Closed

refactor: SelectionList multiple selection #22622

Merged

s77rt mentioned this pull request Sep 18, 2023

fix member select highlight issue #27646

Closed

59 tasks

chore: resolve conflicts

f6f3295

thiagobrez mentioned this pull request Sep 19, 2023

[Tracker] Selection List Refactor #11795

Closed

thiagobrez added 2 commits September 21, 2023 14:17

Merge branch 'main' into thiagobrez/selection-list-highlight-jump

edc1d89

fix(selection-list): remove highlight when pressing

48f589e

chore: fix jsdoc

ec40451

allroundexperts reviewed Sep 21, 2023

View reviewed changes

allroundexperts approved these changes Sep 25, 2023

View reviewed changes

melvin-bot bot requested a review from cristipaval September 25, 2023 05:10

cristipaval approved these changes Sep 25, 2023

View reviewed changes

cristipaval merged commit 38030f8 into Expensify:main Sep 25, 2023
14 of 16 checks passed

OSBotify mentioned this pull request Sep 28, 2023

Deploy Checklist: New Expensify 2023-09-28 #28412

Closed

OSBotify mentioned this pull request Oct 2, 2023

Deploy Checklist: New Expensify 2023-10-02 #28635

Closed

s77rt mentioned this pull request Oct 3, 2023

[$500] Workspace - Invite member - Member highlights on deselect all members #27377

Closed

6 tasks

Krishna2323 mentioned this pull request Feb 5, 2024

[HOLD for payment 2024-02-22] [$250] Workspace - Workspace highlighted member blinks when check/uncheck mark #35761

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(selection-list): highlight on lists with 1 section #27246

fix(selection-list): highlight on lists with 1 section #27246

thiagobrez commented Sep 12, 2023

melvin-bot bot commented Sep 12, 2023

thiagobrez commented Sep 12, 2023

allroundexperts commented Sep 12, 2023

thiagobrez commented Sep 12, 2023

allroundexperts commented Sep 12, 2023

allroundexperts commented Sep 12, 2023 •

edited

Loading

shawnborton commented Sep 12, 2023

allroundexperts commented Sep 12, 2023

thiagobrez commented Sep 12, 2023

allroundexperts commented Sep 12, 2023

thiagobrez commented Sep 12, 2023

shawnborton commented Sep 13, 2023

thiagobrez commented Sep 13, 2023

shawnborton commented Sep 14, 2023

thiagobrez commented Sep 14, 2023

shawnborton commented Sep 15, 2023

thiagobrez commented Sep 18, 2023

allroundexperts commented Sep 19, 2023

allroundexperts commented Sep 19, 2023

thiagobrez commented Sep 21, 2023

thiagobrez commented Sep 21, 2023 •

edited

Loading

allroundexperts Sep 21, 2023

thiagobrez Sep 21, 2023

allroundexperts left a comment

OSBotify commented Sep 25, 2023

OSBotify commented Sep 28, 2023

OSBotify commented Oct 2, 2023

OSBotify commented Oct 2, 2023

OSBotify commented Oct 3, 2023

fix(selection-list): highlight on lists with 1 section #27246

fix(selection-list): highlight on lists with 1 section #27246

Conversation

thiagobrez commented Sep 12, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 12, 2023

thiagobrez commented Sep 12, 2023

allroundexperts commented Sep 12, 2023

thiagobrez commented Sep 12, 2023

allroundexperts commented Sep 12, 2023

allroundexperts commented Sep 12, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

shawnborton commented Sep 12, 2023

allroundexperts commented Sep 12, 2023

thiagobrez commented Sep 12, 2023

allroundexperts commented Sep 12, 2023

thiagobrez commented Sep 12, 2023

shawnborton commented Sep 13, 2023

thiagobrez commented Sep 13, 2023

shawnborton commented Sep 14, 2023

thiagobrez commented Sep 14, 2023

shawnborton commented Sep 15, 2023

thiagobrez commented Sep 18, 2023

allroundexperts commented Sep 19, 2023

allroundexperts commented Sep 19, 2023

thiagobrez commented Sep 21, 2023

thiagobrez commented Sep 21, 2023 • edited Loading

allroundexperts Sep 21, 2023

Choose a reason for hiding this comment

thiagobrez Sep 21, 2023

Choose a reason for hiding this comment

allroundexperts left a comment

Choose a reason for hiding this comment

OSBotify commented Sep 25, 2023

OSBotify commented Sep 28, 2023

OSBotify commented Oct 2, 2023

OSBotify commented Oct 2, 2023

OSBotify commented Oct 3, 2023

allroundexperts commented Sep 12, 2023 •

edited

Loading

thiagobrez commented Sep 21, 2023 •

edited

Loading