Show tooltip below as soon as another element overlap the top edge #20240

bernhardoj · 2023-06-06T06:25:07Z

Details

Just a small improvement to show tooltip below the element as soon as another element overlap the top edge of the element.

Fixed Issues

$ #15796
PROPOSAL: GH_LINK_ISSUE(COMMENT)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Web/Desktop

Open a chat with a quite long message history
Scroll the chat until one of the avatar is a little bit behind the chat header
Hover over the avatar
Verify the tooltip shows below the avatar

Android/iOS/mWeb
No tooltip

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 / 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
- 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 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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

melvin-bot · 2023-06-06T06:25:13Z

@pecanoro @parasharrajat 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]

parasharrajat · 2023-06-09T13:38:42Z

Because you are fixing the tooltip direction. I would say we fix this issue as well. Sometimes, the tooltip is rendered below the element even though there is enough space above the target. This is completely random. I noticed this more when I scroll the chat history and hover over a avatar from the old message.

Screen.Recording.2023-06-09.at.7.06.49.PM.mov

bernhardoj · 2023-06-09T14:20:29Z

Hmm, that's weird. I merged with main and try to reproduce it but I can't. I have pushed it, can you retest once again?

parasharrajat · 2023-06-09T17:34:32Z

It's a strange one. I will retest.

parasharrajat · 2023-06-12T07:33:35Z

Still facing that issue. Can you share a video of your screen? Also, try with the same message as shown in the video. For example, I used a mention, inline code block etc.

Screen.Recording.2023-06-12.at.1.03.47.PM.mov

bernhardoj · 2023-06-12T10:28:47Z

Here is mine:

Screen.Recording.2023-06-12.at.18.16.31.mov

The only guess I have is, it overlaps with tooltip arrow, sometimes, in a specific browser and version. I have tested on Chrome, Edge, Safari and Firefox and can't reproduce it. 2 things to try:

Use different browser
Add shiftVertical (maybe 5 or more) to the tooltip in ReportActionItemSingle

parasharrajat · 2023-06-12T15:40:01Z

Strange. I will retest.

pecanoro · 2023-06-14T15:21:44Z

@parasharrajat Did you manage to retest?

parasharrajat · 2023-06-14T15:39:29Z

Yeah, I faced it again and I am trying to find the cause but didn't able to invest much time into it. @pecanoro Can you please also run a test to see if you face the above-mentioned issue?

This will make it clear if I am the only one facing it.

pecanoro · 2023-06-14T20:19:43Z

I can reproduce at all what @parasharrajat is experiencing but I am seeing this, is it only me?

bernhardoj · 2023-06-15T03:37:19Z

@pecanoro I think yes. It is shown below the avatar for me. Are you testing it in a different branch?

I can reproduce at all what @parasharrajat is experiencing

Do you mean "can't"?

pecanoro · 2023-06-15T15:05:31Z

@bernhardoj Ahh yeah, I meant I can't, sorry.

Ok, I will try testing the PR again, not sure if I did something wrong!

parasharrajat · 2023-06-16T20:39:17Z

I checked again.

It seems Chrome looks good but Firefox has the above-mentioned issue. Show tooltip below as soon as another element overlap the top edge #20240 (comment)
I can reproduce this on Chrome Show tooltip below as soon as another element overlap the top edge #20240 (comment).
Steps;

Place your cursor above the first half of the avatar when it is near to Report header.
Scroll slowly up while keeping the cursor on the avatar but move the cursor along.

Screen.Recording.2023-06-17.at.2.14.41.AM.mov

pecanoro · 2023-06-16T22:52:21Z

Restested, in general, it works great, but there is some edge case in which sometimes the tooltip gets stuck on top like Rajat said if you scroll when it's too close to the header, not sure what is the cause of the glitch.

bernhardoj · 2023-06-17T02:47:49Z

Ah, I can also reproduce the 2nd issue while scrolling. I think that never works before. It will only correctly change the position when scrolling (the wheel) up. I guess it's related to late update of bound observer(?). That needs a further investigation.

parasharrajat · 2023-06-21T02:09:40Z

Any finds here @bernhardoj.

bernhardoj · 2023-06-21T03:32:27Z

Ah, I didn't know that we want to solve that. As it never works before, I suggest to create a separate issue for it.

parasharrajat · 2023-06-21T03:57:07Z

Ok. Thanks for the update. I think we can do that. I will complete the checklist asap.

parasharrajat · 2023-06-21T17:13:31Z

@pecanoro thoughts?

pecanoro · 2023-06-22T16:23:49Z

Yeah, let's do that if it has never worked before, it's also an extremely edge case that I don't even know if it's worth fixing. @parasharrajat Feel free to complete the checklist!

parasharrajat · 2023-06-22T19:05:06Z

Screenshots

🔲 iOS / native

Screen.Recording.2023-06-26.at.11.27.58.PM.mov

🔲 iOS / Safari

Screen.Recording.2023-06-26.at.11.28.47.PM.mov

🔲 MacOS / Desktop

Screen.Recording.2023-06-26.at.11.22.35.PM.mov

🔲 MacOS / Chrome

Screen.Recording.2023-06-26.at.11.22.01.PM.mov

🔲 Android / Chrome

Screen.Recording.2023-06-26.at.11.30.07.PM.mov

🔲 Android / native

Screen.Recording.2023-06-27.at.4.27.38.PM.mov

pecanoro · 2023-06-26T16:46:17Z

@parasharrajat Friendly bump on completing the review checklist!

parasharrajat

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

cc: @pecanoro

🎀 👀 🎀 C+ reviewed

parasharrajat

@bernhardoj Can you please merge main into this PR?

bernhardoj · 2023-06-27T03:49:36Z

@parasharrajat merged with main

pecanoro

Tested again, it's working well!

OSBotify · 2023-06-27T18:26:38Z

✋ 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-06-28T14:27:11Z

🚀 Deployed to staging by https://github.com/pecanoro in version: 1.3.34-0 🚀

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

OSBotify · 2023-06-29T20:29:08Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.34-1 🚀

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

s77rt · 2023-09-09T22:06:44Z

src/styles/getTooltipStyles.js

-    // Return true only if both elementAtTargetCenterX and elementAtTargetCenterY overlap with another element
-    return isOverlappingAtTargetCenterX && isOverlappingAtTargetCenterY;
+    return isOverlappingAtTargetCenterX;


This caused a regression #26041. Now we not taking into consideration the height the tooltip shows up at the bottom if there is any element above the tooltip marker, e.g. if we have the unread indicator shown before a report action then the tooltip will show at bottom even though we have enough space at the top.

Before:

After:

The issue that this PR is fixing does not seem to be reproducible, do you think we can revert the PR?

I haven't checked it thoroughly as I can't reach my laptop right now, but I wouldn't say it's a regression. That's how the overlap checking works. It's overlapping if something touches the top of an element. In case of unread indicator, could the height of the unread indicator overlaps with the display name?

For the history (let's use Avatar as an example)

The overlapping logic check whether some element touch the x and y (top-left) of an Avatar

Then, I have PR to change the position to be the center of both x and y (center) of an Avatar

Last, this PR which now check the y and center of the x (top-center) of an Avatar.

We change from center to top-center because it requires an element to overlap vertically 50% (which I believe still the same if you revert this, so I don't think we can revert this PR).

One thing that could be improved is to move down a little bit of the y like 1%, so it would require an element to overlap the Avatar 1% vertically (from the top)

Thanks for the quick response. I think it would be safer to just ignore the unread indicator and keep the overlapping logic as is for now.

bernhardoj added 2 commits June 6, 2023 14:17

show tooltip below as soon as another element overlap the top edge

5d36268

update comment

336f951

bernhardoj requested a review from a team as a code owner June 6, 2023 06:25

melvin-bot bot requested review from parasharrajat and pecanoro and removed request for a team June 6, 2023 06:25

Merge branch 'main' into fix/improve-tooltip-overlap-check

c5ac3f5

hoangzinh mentioned this pull request Jun 12, 2023

[HOLD for payment 2023-07-20] [$1000] The tooltip changes its position when changed the language preference and works well after refreshing the page #17844

Closed

6 tasks

parasharrajat mentioned this pull request Jun 13, 2023

[HOLD for newdot C+ payment] [$1000] Web - Emoji Reaction - Reaction emoji is highlighted twice when using Tab key #15796

Closed

6 tasks

parasharrajat approved these changes Jun 26, 2023

View reviewed changes

parasharrajat suggested changes Jun 26, 2023

View reviewed changes

Merge branch 'main' into fix/improve-tooltip-overlap-check

e52bb39

parasharrajat approved these changes Jun 27, 2023

View reviewed changes

pecanoro approved these changes Jun 27, 2023

View reviewed changes

pecanoro merged commit 27d657e into Expensify:main Jun 27, 2023

OSBotify mentioned this pull request Jun 28, 2023

Deploy Checklist: New Expensify 2023-06-28 #21794

Closed

26 tasks

s77rt reviewed Sep 9, 2023

View reviewed changes

s77rt mentioned this pull request Sep 9, 2023

[$500] IOU - Incorrect Tooltip Position Displayed When Hovering over Email #26041

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Show tooltip below as soon as another element overlap the top edge #20240

Show tooltip below as soon as another element overlap the top edge #20240

bernhardoj commented Jun 6, 2023

melvin-bot bot commented Jun 6, 2023

parasharrajat commented Jun 9, 2023 •

edited

Loading

bernhardoj commented Jun 9, 2023

parasharrajat commented Jun 9, 2023

parasharrajat commented Jun 12, 2023 •

edited

Loading

bernhardoj commented Jun 12, 2023

parasharrajat commented Jun 12, 2023 •

edited

Loading

pecanoro commented Jun 14, 2023

parasharrajat commented Jun 14, 2023

pecanoro commented Jun 14, 2023

bernhardoj commented Jun 15, 2023

pecanoro commented Jun 15, 2023

parasharrajat commented Jun 16, 2023 •

edited

Loading

pecanoro commented Jun 16, 2023

bernhardoj commented Jun 17, 2023

parasharrajat commented Jun 21, 2023

bernhardoj commented Jun 21, 2023

parasharrajat commented Jun 21, 2023

parasharrajat commented Jun 21, 2023

pecanoro commented Jun 22, 2023

parasharrajat commented Jun 22, 2023 •

edited

Loading

pecanoro commented Jun 26, 2023

parasharrajat left a comment

parasharrajat left a comment

bernhardoj commented Jun 27, 2023

pecanoro left a comment

OSBotify commented Jun 27, 2023

OSBotify commented Jun 28, 2023

OSBotify commented Jun 29, 2023

s77rt Sep 9, 2023

s77rt Sep 9, 2023

bernhardoj Sep 10, 2023 •

edited

Loading

s77rt Sep 11, 2023

Show tooltip below as soon as another element overlap the top edge #20240

Show tooltip below as soon as another element overlap the top edge #20240

Conversation

bernhardoj commented Jun 6, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 6, 2023

parasharrajat commented Jun 9, 2023 • edited Loading

bernhardoj commented Jun 9, 2023

parasharrajat commented Jun 9, 2023

parasharrajat commented Jun 12, 2023 • edited Loading

bernhardoj commented Jun 12, 2023

parasharrajat commented Jun 12, 2023 • edited Loading

pecanoro commented Jun 14, 2023

parasharrajat commented Jun 14, 2023

pecanoro commented Jun 14, 2023

bernhardoj commented Jun 15, 2023

pecanoro commented Jun 15, 2023

parasharrajat commented Jun 16, 2023 • edited Loading

pecanoro commented Jun 16, 2023

bernhardoj commented Jun 17, 2023

parasharrajat commented Jun 21, 2023

bernhardoj commented Jun 21, 2023

parasharrajat commented Jun 21, 2023

parasharrajat commented Jun 21, 2023

pecanoro commented Jun 22, 2023

parasharrajat commented Jun 22, 2023 • edited Loading

Screenshots

🔲 iOS / native

🔲 iOS / Safari

🔲 MacOS / Desktop

🔲 MacOS / Chrome

🔲 Android / Chrome

🔲 Android / native

pecanoro commented Jun 26, 2023

parasharrajat left a comment

Choose a reason for hiding this comment

Reviewer Checklist

parasharrajat left a comment

Choose a reason for hiding this comment

bernhardoj commented Jun 27, 2023

pecanoro left a comment

Choose a reason for hiding this comment

OSBotify commented Jun 27, 2023

OSBotify commented Jun 28, 2023

OSBotify commented Jun 29, 2023

s77rt Sep 9, 2023

Choose a reason for hiding this comment

s77rt Sep 9, 2023

Choose a reason for hiding this comment

bernhardoj Sep 10, 2023 • edited Loading

Choose a reason for hiding this comment

s77rt Sep 11, 2023

Choose a reason for hiding this comment

parasharrajat commented Jun 9, 2023 •

edited

Loading

parasharrajat commented Jun 12, 2023 •

edited

Loading

parasharrajat commented Jun 12, 2023 •

edited

Loading

parasharrajat commented Jun 16, 2023 •

edited

Loading

parasharrajat commented Jun 22, 2023 •

edited

Loading

bernhardoj Sep 10, 2023 •

edited

Loading