Add popover anchor tooltip #30150

allroundexperts · 2023-10-22T20:12:38Z

Details

This PR creates a new PopoverAnchorTooltip component that shows the tooltip around popover anchor buttons only when popover is hidden.

Fixed Issues

$ #24296
PROPOSAL: #24296 (comment)

Tests

Click + button on LHN.
Hover over the X icon
Click + in composer
Hover over + icon

Verify that the tooltip is not shown for the popover that is visible.

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Click + button on LHN.
Hover over the X icon
Click + in composer
Hover over + icon

Verify that the tooltip is not shown for the popover that is visible.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2023-10-23.at.1.05.00.AM.mov

Android: mWeb Chrome

Screen.Recording.2023-10-23.at.1.05.38.AM.mov

iOS: Native

Screen.Recording.2023-10-23.at.1.26.56.AM.mov

iOS: mWeb Safari

Screen.Recording.2023-10-23.at.1.03.17.AM.mov

MacOS: Chrome / Safari

Screen.Recording.2023-10-23.at.12.56.09.AM.mov

MacOS: Desktop

Screen.Recording.2023-10-23.at.1.01.24.AM.mov

melvin-bot · 2023-10-22T20:12:43Z

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

situchan · 2023-10-22T20:16:06Z

src/components/Tooltip/tooltipPropTypes.js

@@ -31,6 +31,9 @@ const propTypes = {

    /** passes this down to Hoverable component to decide whether to handle the scroll behaviour to show hover once the scroll ends */
    shouldHandleScroll: PropTypes.bool,
+
+    /** Reference to the tooltip container */
+    tooltipRef: PropTypes.any,


We can use existing refPropTypes defined in /components

situchan · 2023-10-23T00:45:16Z

src/components/Tooltip/tooltipPropTypes.js

@@ -1,4 +1,5 @@
 import PropTypes from 'prop-types';
+import refPropType from '../refPropTypes';


Suggested change

import refPropType from '../refPropTypes';

import refPropTypes from '../refPropTypes';

situchan · 2023-10-23T00:45:37Z

src/components/Tooltip/tooltipPropTypes.js

@@ -33,7 +34,7 @@ const propTypes = {
    shouldHandleScroll: PropTypes.bool,

    /** Reference to the tooltip container */
-    tooltipRef: PropTypes.any,
+    tooltipRef: refPropType,


Suggested change

tooltipRef: refPropType,

tooltipRef: refPropTypes,

situchan · 2023-10-23T20:27:38Z

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

web.mov

Mobile Web - Chrome

mchrome.mov

Mobile Web - Safari

msafari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

src/components/Tooltip/PopoverAnchorTooltip.js

OSBotify · 2023-10-23T22:05:48Z

✋ 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-10-24T01:59:20Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.3.90-0 🚀

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

OSBotify · 2023-10-25T16:36:14Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.90-2 🚀

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

OSBotify · 2023-10-25T17:01:02Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.3.91-0 🚀

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

OSBotify · 2023-10-26T22:43:03Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.91-8 🚀

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

aimane-chnaif · 2024-01-02T20:53:18Z

src/components/Tooltip/PopoverAnchorTooltip.js

+    if (!shouldRender || isPopoverRelatedToTooltipOpen) {
+        return children;
+    }


This conditional render caused regression.
More details: #31155 (comment)

allroundexperts added 6 commits September 26, 2023 06:09

fix: popover interaction with tooltip

7c35385

merge with main

582ae7b

fix: re-add tooltip logic

0486567

fix: add missing condition for tooltip popover

19ac134

Merge branch 'main' into fix-24296

a9f4d5c

feat: popover anchor tooltip component

824f7ea

allroundexperts requested a review from a team as a code owner October 22, 2023 20:12

melvin-bot bot requested review from situchan and removed request for a team October 22, 2023 20:12

allroundexperts mentioned this pull request Oct 22, 2023

[HOLD for payment 2023-11-01] [$1000] Tooltips should not show when the related context menu is open #24296

Closed

6 tasks

situchan reviewed Oct 22, 2023

View reviewed changes

feat: use correct prop type

85aed6f

allroundexperts requested a review from situchan October 22, 2023 20:51

situchan reviewed Oct 23, 2023

View reviewed changes

feat: use plural name for ref prop types

21cca81

allroundexperts requested a review from situchan October 23, 2023 01:27

situchan approved these changes Oct 23, 2023

View reviewed changes

melvin-bot bot requested a review from luacmartins October 23, 2023 20:28

luacmartins reviewed Oct 23, 2023

View reviewed changes

src/components/Tooltip/PopoverAnchorTooltip.js Outdated Show resolved Hide resolved

luacmartins reviewed Oct 23, 2023

View reviewed changes

src/components/Tooltip/PopoverAnchorTooltip.js Outdated Show resolved Hide resolved

fix: add check to see if ref is defined

6316669

allroundexperts requested a review from luacmartins October 23, 2023 21:43

luacmartins approved these changes Oct 23, 2023

View reviewed changes

luacmartins merged commit 112061b into Expensify:main Oct 23, 2023
13 checks passed

OSBotify mentioned this pull request Oct 24, 2023

Deploy Checklist: New Expensify 2023-10-24 #30224

Closed

43 tasks

OSBotify mentioned this pull request Oct 25, 2023

Deploy Checklist: New Expensify 2023-10-25 #30365

Closed

99 tasks

aimane-chnaif mentioned this pull request Nov 20, 2023

[HOLD for payment 2024-01-26] [$500] Emoji - When resizing the window, the open emoji picker moves to the LHN side #31155

Closed

6 tasks

aimane-chnaif reviewed Jan 2, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add popover anchor tooltip #30150

Add popover anchor tooltip #30150

allroundexperts commented Oct 22, 2023 •

edited

Loading

melvin-bot bot commented Oct 22, 2023

situchan Oct 22, 2023

allroundexperts Oct 22, 2023

situchan Oct 23, 2023

allroundexperts Oct 23, 2023

situchan Oct 23, 2023

allroundexperts Oct 23, 2023

situchan commented Oct 23, 2023

OSBotify commented Oct 23, 2023

OSBotify commented Oct 24, 2023

OSBotify commented Oct 25, 2023

OSBotify commented Oct 25, 2023

OSBotify commented Oct 26, 2023

aimane-chnaif Jan 2, 2024

		@@ -1,4 +1,5 @@
		import PropTypes from 'prop-types';
		import refPropType from '../refPropTypes';

	import refPropType from '../refPropTypes';
	import refPropTypes from '../refPropTypes';

Add popover anchor tooltip #30150

Add popover anchor tooltip #30150

Conversation

allroundexperts commented Oct 22, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 22, 2023

situchan Oct 22, 2023

Choose a reason for hiding this comment

allroundexperts Oct 22, 2023

Choose a reason for hiding this comment

situchan Oct 23, 2023

Choose a reason for hiding this comment

allroundexperts Oct 23, 2023

Choose a reason for hiding this comment

situchan Oct 23, 2023

Choose a reason for hiding this comment

allroundexperts Oct 23, 2023

Choose a reason for hiding this comment

situchan commented Oct 23, 2023

Reviewer Checklist

Screenshots/Videos

OSBotify commented Oct 23, 2023

OSBotify commented Oct 24, 2023

OSBotify commented Oct 25, 2023

OSBotify commented Oct 25, 2023

OSBotify commented Oct 26, 2023

aimane-chnaif Jan 2, 2024

Choose a reason for hiding this comment

allroundexperts commented Oct 22, 2023 •

edited

Loading