Feature: Tooltip for QAB #40066

tienifr · 2024-04-11T02:34:57Z

Details

Display a tooltip the first time the QAB is set.

Fixed Issues

$ #38054
PROPOSAL: #38054 (comment)

Tests

Press FAB
Verify the tooltip appears above quick action shortcut
Verify that after 5 seconds, the tooltip disappears
Press the quick action shortcut and complete its flow
Press FAB
Verify the tooltip does not appear

Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

Press FAB
Verify the tooltip appears above quick action shortcut
Verify that after 5 seconds, the tooltip disappears
Press the quick action shortcut and complete its flow
Press FAB
Verify the tooltip does not appear

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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

trjExpensify · 2024-04-11T12:37:52Z

Niceee! Will we be able to put this into review today?

melvin-bot · 2024-04-11T16:51:07Z

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

tienifr · 2024-04-11T16:51:27Z

src/languages/es.ts

@@ -602,6 +602,10 @@ export default {
        trackManual: 'Crear Gasto',
        trackScan: 'Crear Recibo',
        trackDistance: 'Crear Gasto por desplazamiento',
+        tooltip: {


Copy was verified here.

tienifr · 2024-04-11T16:53:57Z

src/components/Tooltip/BaseTooltip/index.tsx

+                                    if (!shouldRenderWithoutHover) {
+                                        return;
+                                    }
+                                    const childrenRect = e.nativeEvent.target?.getBoundingClientRect();


The event target here is specific to react-native-web only.

tienifr · 2024-04-11T16:55:09Z

src/components/Tooltip/BaseTooltip/index.native.tsx

+    }, []);
+
+    useEffect(() => {
+        const intervalID = setInterval(hideTooltip, 5000);


There's no observable user interaction to close this tooltip (cannot hover on mobile devices) so I assume that it should be closed in 5 seconds. Need design feedback here.

@dubielzyk-expensify, whatcha' think? I think 5 seconds is fine.

You can refer to the iOS Native screenshots in PR description to have a better sense.

That feels right to me as long as it dismissed on any tap anyways.

Yeah, any tap in the GC menu navigates you onwards to another page so it should be dismissed.

…oltip-for-qab

dubielzyk-expensify · 2024-04-12T04:08:51Z

I like the little zoom out animation, but could we try it coming from the origin on where the pointing tip is? Feels a bit more correct

shawnborton · 2024-04-12T08:13:47Z

@dubielzyk-expensify does this font size match your mocks? It looks like the tooltip font size is using normal font size which is 15px... just checking in case you intended for it to use the label size at 13px:

shawnborton · 2024-04-12T08:16:00Z

src/styles/index.ts

@@ -3674,6 +3674,22 @@ const styles = (theme: ThemeColors) =>
            ...wordBreak.breakWord,
        },

+        quickActionTooltipWrapper: {
+            backgroundColor: colors.green100,


cc @dubielzyk-expensify - are you thinking to use the same background color across themes?

Either way, I think we should make this a variable that is stored in both themes, basically treating it like any other color style we use.

Yes I forgot to ask you about this. I couldn't get the exact color hex from the mockup.

If we go with the one specified above, then yes, I was gonna keep the same look regardless of theme as it feels good in both light and dark mode

Okay sweet, thanks for confirming. Even though they are the same across both themes, I think we should still take the same approach we do for all other colors here.

Also noting that we do have existing tooltip styles, so maybe we can consider this an extension of that... like highlightTooltip or something?

I like that idea!

shawnborton · 2024-04-12T08:16:19Z

src/styles/index.ts

+        quickActionTooltipTitle: {
+            fontFamily: FontUtils.fontFamily.platform.EXP_NEUE_BOLD,
+            fontWeight: FontUtils.fontWeight.bold,
+            fontSize: variables.fontSizeNormal,


cc @dubielzyk-expensify in case this should be label and not normal.

Yep should be label

shawnborton · 2024-04-12T08:16:34Z

src/styles/index.ts

+            fontWeight: FontUtils.fontWeight.bold,
+            fontSize: variables.fontSizeNormal,
+            lineHeight: variables.lineHeightXLarge,
+            color: colors.green500,


Same comment as above, we should make these theme-friendly color values.

If this color does not differ between the themes, should we make them theme-friendly? Otherwise can you give me the mockup in light mode?

And I need the exact color of the text here as well.

If this color does not differ between the themes, should we make them theme-friendly?

My vote is yes, in case we ever add a 3rd theme or make these theme dependent in the future.

shawnborton · 2024-04-12T08:17:06Z

src/styles/index.ts

+            fontFamily: FontUtils.fontFamily.platform.EXP_NEUE_BOLD,
+            fontWeight: FontUtils.fontWeight.bold,
+            fontSize: variables.fontSizeNormal,
+            lineHeight: variables.lineHeightXLarge,


Why do we need a huge line height here? I would think we could just vertically center the text via flex or use inner padding instead? I don't feel strongly though. Curious what we are using in the Figma.

…oltip-for-qab

dubielzyk-expensify · 2024-04-12T08:53:42Z

It looks like the tooltip font size is using normal font size which is 15px... just checking in case you intended for it to use the label size at 13px:

The intent was to use label correct. Happy to have that opinion challenged though.

As for the background color I think we could potentially look into a variant if it doesn't fit what we want:

shawnborton · 2024-04-12T08:56:03Z

Ah to be clear, I'm not challenging your font choice or background choice. I was just confirming that the font choice in this PR was correct, and it looks like it wasn't. I'm down with 13px.

Then for your background color, again I'm cool with what it looks like but just wanted to confirm if it changes across themes or not? What does the light mode version look like?

dubielzyk-expensify · 2024-04-12T09:01:28Z

What does the light mode version look like?

cubuspl42 · 2024-04-12T09:18:09Z

src/components/Tooltip/TooltipRenderedOnPageBody/index.native.tsx

@@ -0,0 +1,137 @@
+import React, {useEffect, useMemo, useRef, useState} from 'react';


File-scoped comment.

The amount of duplication between index.tsx and index.native.tsx is unacceptable. This is a big one.

Likely, there's a tough refactoring ahead of us.

The amount of duplication between index.tsx and index.native.tsx is unacceptable. This is a big one.

I have thought about this a lot but this is just a temporary fix for the current expected behavior. The tooltip's position logic is really complicated and it's very hard to mimic all that for native platforms. For example, I eliminated shouldShowBelow check and horizontalShift calculations.

But as the mockup here implied, I think they would want to make all that behaviors work on native in the future. So I think seperating these files is neccessary.

I'm not saying that we don't need any platform-splitting to *.tsx and *.native.tsx files, or that we need to implement all complex features on Native that the general-case Web hover-on tooltips need. On Native we'll be showing only the "educational" tooltips.

For example, you correctly assumed that it's not required to dynamically resize tooltips, as educational tootlips likely won't need this behavior soon, or ever. In general, the hover-on tooltips can resize in corner cases.

Still, there are many code de-duplication techniques that can be applied here, even with the simplifications and shortcomings we accepted.

Please give this a try. I feel like little effort has been put into de-duplication here so far. But if you run out of ideas, let me know, as I'll likely be able to help.

HI @cubuspl42, I've tried it but considering the only difference between those files are how the wrapper and content are measure, and the complexity of the web implementation, I couldn't come up with a better solution. Could you please suggest me some approaches to speed things up?

TooltipRenderedOnPageBody is still basically a copy-pasted component, though. We should use the same techniques in this case.

Deduplication for TooltipRenderedOnPageBody would be to lift these logic up to GenericTooltip but the bound measurement and getTooltipStyle must stay in the same component otherwise it would cause a state "unsynchronization" and cause #18189. I think that's the minimum logic required for everything to function properly and won't need deduplication.

How's about BaseGenericTooltip

Semantically, I don't think it's that's a lucky choice. In this case, we're not only having yet-another-layer of component that's actually used to render the same chunk of UI eventually. Remember that the name Tootlip was always meaning the tooltip target wrapper, while TooltipRenderedOnPageBody was focused on realizing the actual tooltip wrapper & content.

Pragmatically, we have another problem. As I'm challenging the amount of duplication in this new TooltipRenderedOnPageBody replacement (let's call it RenderedTooltip for this reasoning), the solution might involve creating BaseRenderedTooltip, while BaseBaseGenericTooltip sounds kind of mad.

So I'd vote for some Base-less Generic-less name, and RenderedTooltip sounded like a minimal change, just throwing out the DOM-specific aspect (OnPageBody / on page <body>).

What also somehow bothers me is that BaseFoo can mean anything, it just says "well, Foo was taken 🤷‍♂️". It's either because we want a BaseFoo optionally-rendered by Foo , it can also be cross-platform BaseFoo, where actual platform-specific Foo injects some delegates, and here it's just a BaseFoo rendered in another cooridante space, owned by Foo. It's a naming mess, in my opinion. I wouldn't add to it if possible.

In our case, number 2 (base foo = cross-platform foo) collides with number 3 (base foo = different coords foo)

@tienifr, we could at least lift this rendering logic up to a generic component, what do you think?

src/styles/utils/generators/TooltipStyleUtils/index.native.ts

trjExpensify · 2024-06-10T13:56:13Z

@eVoloshchak @Gonals can we get feedback to @tienifr on the above, please?

tienifr · 2024-06-10T13:58:55Z

I'm still testing its feasibility. Anyway, it still seems overkill. I'll push the latest changes today.

trjExpensify · 2024-06-10T16:15:44Z

Thanks, please do!

pecanoro · 2024-06-12T22:26:03Z

Any news on this? We also got a new conflicts 😄

…oltip-for-qab

trjExpensify · 2024-06-13T09:00:27Z

@tienifr I see commits, is it ready for @eVoloshchak to take another look? 🙏

…oltip-for-qab

tienifr · 2024-06-13T17:44:58Z

Something was wrong with the popover size on main:

But I resolved the issue with animationOutTiming above by calling hideTooltip in popover's onClose. @eVoloshchak This is ready for your review again.

tienifr · 2024-06-13T17:46:57Z

Check failures are not related to this PR.

…oltip-for-qab

Gonals · 2024-06-18T08:45:06Z

Seems like we have some conflicts

…oltip-for-qab

tienifr · 2024-06-18T08:55:05Z

All set! Awaiting input from @eVoloshchak.

eVoloshchak

Tests well
Awesome job, @tienifr!

trjExpensify · 2024-06-18T20:43:10Z

@Gonals @pecanoro 👀 👀 🙏

OSBotify · 2024-06-19T08:04:34Z

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

pecanoro · 2024-06-19T16:25:21Z

@Gonals You could have waited for my final review 😞

OSBotify · 2024-06-19T21:51:55Z

🚀 Deployed to staging by https://github.com/Gonals in version: 1.4.86-0 🚀

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

OSBotify · 2024-06-19T22:16:37Z

🚀 Deployed to staging by https://github.com/Gonals in version: 1.4.86-0 🚀

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

OSBotify · 2024-06-19T22:50:36Z

🚀 Deployed to staging by https://github.com/Gonals in version: 1.4.86-0 🚀

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

OSBotify · 2024-06-21T21:21:14Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 9.0.0-9 🚀

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

tienifr added 3 commits April 11, 2024 09:34

tooltip for qab

35a5ce1

Merge branch 'main' into feature/tooltip-for-qab

766a444

left align the tooltip

5acd1c7

tienifr added 3 commits April 11, 2024 21:02

show tooltip on native

850b665

add Spanish copy

d1b9af2

fix typecheck

4aa688e

tienifr marked this pull request as ready for review April 11, 2024 16:51

tienifr requested review from a team as code owners April 11, 2024 16:51

melvin-bot bot requested review from cubuspl42 and removed request for a team April 11, 2024 16:51

tienifr commented Apr 11, 2024

View reviewed changes

tienifr added 2 commits April 12, 2024 10:25

Merge branch 'main' of https://github.com/tienifr/App into feature/to…

5efedaa

…oltip-for-qab

modify bold text on android

77b2701

shawnborton reviewed Apr 12, 2024

View reviewed changes

tienifr added 2 commits April 12, 2024 15:32

Merge branch 'main' of https://github.com/tienifr/App into feature/to…

ea8719d

…oltip-for-qab

update font size

2fa14e6

cubuspl42 suggested changes Apr 12, 2024

View reviewed changes

trjExpensify mentioned this pull request Jun 10, 2024

[Tracking] [Wave Collect] [Quick Action] NewDot: Quick Action Button #34802

Closed

33 tasks

tienifr added 2 commits June 13, 2024 05:31

Merge branch 'main' of https://github.com/tienifr/App into feature/to…

8714827

…oltip-for-qab

fix lint

28f8583

tienifr added 2 commits June 14, 2024 00:08

Merge branch 'main' of https://github.com/tienifr/App into feature/to…

bfab75d

…oltip-for-qab

hide tooltip during popover animation out

1373c0c

tienifr added 2 commits June 14, 2024 01:06

Merge branch 'main' of https://github.com/tienifr/App into feature/to…

84096b7

…oltip-for-qab

Merge branch 'main' of https://github.com/tienifr/App into feature/to…

eb35978

…oltip-for-qab

Merge branch 'main' of https://github.com/tienifr/App into feature/to…

6ef72be

…oltip-for-qab

eVoloshchak approved these changes Jun 18, 2024

View reviewed changes

melvin-bot bot requested a review from pecanoro June 18, 2024 15:43

Gonals approved these changes Jun 19, 2024

View reviewed changes

Gonals merged commit e213e89 into Expensify:main Jun 19, 2024
16 checks passed

github-actions bot mentioned this pull request Jun 19, 2024

Deploy Checklist: New Expensify 2024-06-19 #44047

Closed

59 tasks

tienifr mentioned this pull request Jul 12, 2024

[HOLD for payment 2024-08-19] [Guided Setup Stage 3] Add the tooltip for Workspace Chat #45046

Closed

		@@ -0,0 +1,137 @@
		import React, {useEffect, useMemo, useRef, useState} from 'react';

Feature: Tooltip for QAB #40066

Feature: Tooltip for QAB #40066

Conversation

tienifr commented Apr 11, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

trjExpensify commented Apr 11, 2024

melvin-bot bot commented Apr 11, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tienifr Apr 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dubielzyk-expensify commented Apr 12, 2024

shawnborton commented Apr 12, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dubielzyk-expensify commented Apr 12, 2024

shawnborton commented Apr 12, 2024

dubielzyk-expensify commented Apr 12, 2024

Choose a reason for hiding this comment

tienifr Apr 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

trjExpensify commented Jun 10, 2024

tienifr commented Jun 10, 2024

trjExpensify commented Jun 10, 2024

pecanoro commented Jun 12, 2024

trjExpensify commented Jun 13, 2024

tienifr commented Jun 13, 2024 • edited Loading

tienifr commented Jun 13, 2024

Gonals commented Jun 18, 2024

tienifr commented Jun 18, 2024

eVoloshchak left a comment

Choose a reason for hiding this comment

trjExpensify commented Jun 18, 2024

OSBotify commented Jun 19, 2024

pecanoro commented Jun 19, 2024

OSBotify commented Jun 19, 2024

OSBotify commented Jun 19, 2024

OSBotify commented Jun 19, 2024

OSBotify commented Jun 21, 2024

tienifr commented Apr 11, 2024 •

edited

Loading

tienifr Apr 12, 2024 •

edited

Loading

tienifr Apr 12, 2024 •

edited

Loading

tienifr commented Jun 13, 2024 •

edited

Loading