feat(selection-list): add tooltip #26091

thiagobrez · 2023-08-28T14:59:20Z

Details

Add Tooltip to list items on Workspace Members Page and Workspace Invite page

Fixed Issues

$ #25895
PROPOSAL:

Tests

Verify that no errors appear in the JS console

In Workspace -> Members:

For the first 10 items: hovering over the avatar, name or email should show a tooltip. The avatar tooltip contains all info (avatar, name and email). The other 2, only their respective info
After the 10th item, hover is disabled

In Workspace -> Members -> Invite:

For the first 10 items: hovering over the avatar, name or email should show a tooltip. The avatar tooltip contains all info (avatar, name and email). The other 2, only their respective info
After the 10th item, hover is disabled

Offline tests

QA Steps

Verify that no errors appear in the JS console

In Workspace -> Members:

For the first 10 items: hovering over the avatar, name or email should show a tooltip. The avatar tooltip contains all info (avatar, name and email). The other 2, only their respective info
After the 10th item, hover is disabled

In Workspace -> Members -> Invite:

For the first 10 items: hovering over the avatar, name or email should show a tooltip. The avatar tooltip contains all info (avatar, name and email). The other 2, only their respective info
After the 10th item, hover is disabled

PR Author Checklist

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

melvin-bot · 2023-08-28T17:10:18Z

@Santhosh-Sellavel 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]

src/components/SelectionList/CheckboxListItem.js

src/components/SelectionList/UserListItem.js

src/components/SelectionList/BaseSelectionList.js

aldo-expensify · 2023-08-31T19:07:59Z

I'm adding a HOLD on merging here since I don't think this is an important bug. Let me know if you think otherwise or feel free to raise it in slack if you think we should merge this.

Santhosh-Sellavel · 2023-09-03T22:30:52Z

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

Screen.Recording.2023-09-04.at.3.45.41.AM.mov

Mobile Web - Chrome & Mobile Web - Safari

Screen.Recording.2023-09-04.at.4.07.02.AM.mov

iOS & Android

Screen.Recording.2023-09-04.at.5.08.20.AM.mov

thiagobrez · 2023-09-12T08:06:42Z

@aldo-expensify @Santhosh-Sellavel Friendly bump here, now that merge freeze is lifted

OSBotify · 2023-09-13T13:22:35Z

✋ 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-14T10:53:04Z

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

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

OSBotify · 2023-09-18T10:11:03Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.70-8 🚀

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

jjcoffee · 2024-01-25T09:52:50Z

src/components/SelectionList/BaseSelectionList.js

-        const isFocused = !isDisabled && focusedIndex === index + lodashGet(section, 'indexOffset', 0);
+        const isFocused = !isDisabled && focusedIndex === normalizedIndex;
+        // We only create tooltips for the first 10 users or so since some reports have hundreds of users, causing performance to degrade.
+        const showTooltip = normalizedIndex < 10;


Since SelectionList is used for other, non-user lists, this caused issues (#33172) where it's unexpected to limit tooltips to the first 10 items.

thiagobrez added 2 commits August 28, 2023 15:49

feat(selection-list): add tooltip

8fc594b

fix(selection-list): accountID to number

883fb01

thiagobrez marked this pull request as ready for review August 28, 2023 17:10

thiagobrez requested a review from a team as a code owner August 28, 2023 17:10

melvin-bot bot requested review from Santhosh-Sellavel and removed request for a team August 28, 2023 17:10

thiagobrez mentioned this pull request Aug 28, 2023

Workspace - Tooltip is miising on hover in invite members page #25895

Closed

6 tasks

aldo-expensify self-requested a review August 28, 2023 17:27

Santhosh-Sellavel reviewed Aug 28, 2023

View reviewed changes

src/components/SelectionList/CheckboxListItem.js Show resolved Hide resolved

refactor(selection-list): rename CheckboxListItem to UserListItem

5c67b87

Santhosh-Sellavel reviewed Aug 30, 2023

View reviewed changes

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

fix(selection-list): make showTooltip required

0b2d4b4

Santhosh-Sellavel reviewed Aug 30, 2023

View reviewed changes

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

aldo-expensify changed the title ~~feat(selection-list): add tooltip~~ [HOLD merge freeze] feat(selection-list): add tooltip Aug 31, 2023

aldo-expensify changed the title ~~[HOLD merge freeze] feat(selection-list): add tooltip~~ feat(selection-list): add tooltip Sep 12, 2023

aldo-expensify approved these changes Sep 13, 2023

View reviewed changes

aldo-expensify merged commit b7539df into Expensify:main Sep 13, 2023
13 of 19 checks passed

OSBotify mentioned this pull request Sep 14, 2023

Deploy Checklist: New Expensify 2023-09-14 #27425

Closed

jjcoffee mentioned this pull request Dec 18, 2023

[HOLD for payment 2024-01-24] [$500] Settings - Only top 10 timezones have tooltip #33172

Closed

6 tasks

jjcoffee reviewed Jan 25, 2024

View reviewed changes

tienifr mentioned this pull request Jan 30, 2024

[HOLD for payment 2024-02-14] [$500] Web - Settings - The same text is also displayed as tooltips #34961

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(selection-list): add tooltip #26091

feat(selection-list): add tooltip #26091

thiagobrez commented Aug 28, 2023 •

edited

Loading

melvin-bot bot commented Aug 28, 2023

aldo-expensify commented Aug 31, 2023

Santhosh-Sellavel commented Sep 3, 2023 •

edited

Loading

thiagobrez commented Sep 12, 2023

OSBotify commented Sep 13, 2023

OSBotify commented Sep 14, 2023

OSBotify commented Sep 18, 2023

jjcoffee Jan 25, 2024

feat(selection-list): add tooltip #26091

feat(selection-list): add tooltip #26091

Conversation

thiagobrez commented Aug 28, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 28, 2023

aldo-expensify commented Aug 31, 2023

Santhosh-Sellavel commented Sep 3, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

thiagobrez commented Sep 12, 2023

OSBotify commented Sep 13, 2023

OSBotify commented Sep 14, 2023

OSBotify commented Sep 18, 2023

jjcoffee Jan 25, 2024

Choose a reason for hiding this comment

thiagobrez commented Aug 28, 2023 •

edited

Loading

Santhosh-Sellavel commented Sep 3, 2023 •

edited

Loading