fix: prevent tool tip from filling container #35735

aswin-s · 2024-02-02T22:10:29Z

Details

This PR fixes a regression from #33542 where tooltip was misaligned.

Reason for regression:

For fixing layout issue on Android where Text component was not taking full available width, alignItems: 'stretch' was applied to parent container in UserListItem component. However on web this caused ToolTip component to fill the parent container instead of wrapping its child text content.

To fix this issue, the ToolTip element in UserList item is wrapped in another Text tag so that ToolTip will not inherit any flex properties from its parent flex container. This fixes the regression that occured on Web platform.

Fixed Issues

$ #35691
PROPOSAL: #35691 (comment)

Tests

Open the App
Login with any account who has an active Workspace
Navigate to Workspace Settings -> Members
Verify that all items in member list occupy full width and there is no large gap between the tag and display name.
Verify that tool tips over member list items are aligned properly on Web & Desktop.

Verify that no errors appear in the JS console

Offline tests

Open the App
Login with any account who has an active Workspace
Navigate to Workspace Settings -> Members
Verify that all items in member list occupy full width and there is no large gap between the tag and display name.
Verify that tool tips over member list items are aligned properly on Web & Desktop.

QA Steps

Open the App
Login with any account who has an active Workspace
Navigate to Workspace Settings -> Members
Verify that all items in member list occupy full width and there is no large gap between the tag and display name.
Verify that tool tips over member list items are aligned properly on Web & Desktop.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android_out.mp4

Android: mWeb Chrome

android_web_out.mp4

iOS: Native

ios_out.mp4

iOS: mWeb Safari

ios-mweb_out.mp4

MacOS: Chrome / Safari

web_out.mp4

MacOS: Desktop

desktop_out.mp4

melvin-bot · 2024-02-02T22:10:34Z

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

hayata-suenaga · 2024-02-02T23:30:28Z

@sobitneupane when you have time, could you review the PR please?

sobitneupane

Thanks @aswin-s. But I don't think it's good idea to use Text component as layout container. Let's not go with the workaround.

I believe we should go back to the initial issue. Let's revert the change and try to solve the initial issue.

aswin-s · 2024-02-05T09:32:32Z

@sobitneupane Root cause and the fix is correct. align-item:flex-start on parent container will cause Text elements to wrap early on native devices. So we need to use align-items:stretch. There is no other fix for this.

What happened with ToolTip is something very specific to Web. Tooltip is an immediate child of the container where align-items:stretch is defined, it uses the Text components width to position itself. Since the text element is taking full width Tooltip uses with width to position itself even though text content is short.

An alternative approach would be to use styles.alignItemsStrech only on native as the issue is present only on native.

We could introduce an isNative check in UserListItem component to swap the style on web.

const platform = getPlatform();
const isNative = platform === CONST.PLATFORM.IOS || platform === CONST.PLATFORM.ANDROID;

Or we could create a separate UserListItem.native.tsx for native devices.

sobitneupane · 2024-02-05T11:11:21Z

@aswin-s We cannot introduce platform specific code in UserListItem. But if it is the only solution, we can add something similar to src/styles/utils/italic or src/styles/utils/wordbreak.

aswin-s · 2024-02-05T12:30:29Z

@sobitneupane Moved container styles into platform specific files. We cannot make it as generic like wordWrap because alignItemsStretch has other uses on web.

sobitneupane · 2024-02-05T13:02:40Z

Thanks for the update @aswin-s. Can you please retest in Web and Native and re-upload the screen recordings since we totally changed the approach.

aswin-s · 2024-02-05T13:41:36Z

@sobitneupane Updated the screengrabs

sobitneupane

Screenshots/Videos

Android: Native

Screen.Recording.2024-02-05.at.20.12.43.mov

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2024-02-05.at.20.02.32.mov

MacOS: Desktop

Screen.Recording.2024-02-05.at.20.09.25.mov

sobitneupane

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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(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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

hayata-suenaga · 2024-02-05T17:32:02Z

@roryabraham would you like to review the PR as you also reviewed the proposal? I don't know why melvin assigned me 🤔

sobitneupane · 2024-02-06T05:49:52Z

@aswin-s Looks like we've got a merge conflict here. Mind taking a look and resolving it?

aswin-s · 2024-02-06T06:13:50Z

@sobitneupane Merged master. However TextWithTooltip component seems to be broken on main.

roryabraham · 2024-02-06T17:07:51Z

src/styles/utils/getUserListItemStyles/index.native.ts

@@ -0,0 +1,5 @@
+import type GetContextMenuItemStyle from './types';
+
+const getUserListItemStyles: GetContextMenuItemStyle = (styles) => [styles.flex1, styles.flexColumn, styles.justifyContentCenter, styles.alignItemsStretch, styles.optionRow];


Can we create a baseStyles.ts file with all the common styles to make it clear what's different between web and mobile. I think in general we have developed too big an appetite for platform differences in our codebase.

roryabraham

So I mentioned on the issue that I'm unable to get tooltips to show up at all, and as such the test steps on this PR are not passing.

But assuming that whatever other regression is causing that is fixed, I'd like to see us take another approach that doesn't require platform fragmentation.

Maybe just add a style prop to the tooltip component so that we can optionally make it align with its container's start rather than its center.

fix: prevent tool tip from filling container

d49b338

aswin-s requested a review from a team as a code owner February 2, 2024 22:10

melvin-bot bot requested review from sobitneupane and removed request for a team February 2, 2024 22:10

aswin-s mentioned this pull request Feb 2, 2024

[$500] Workspace - Tooltip is at the center instead of above display name #35691

Closed

6 tasks

Merge remote-tracking branch 'upstream/main' into fix/35691

5f0b499

sobitneupane reviewed Feb 5, 2024

View reviewed changes

fix: limit style changes to native

e575218

aswin-s requested a review from sobitneupane February 5, 2024 12:30

sobitneupane reviewed Feb 5, 2024

View reviewed changes

sobitneupane approved these changes Feb 5, 2024

View reviewed changes

melvin-bot bot requested a review from hayata-suenaga February 5, 2024 14:42

Merge remote-tracking branch 'upstream/main' into fix/35691

f03c0d8

roryabraham requested changes Feb 6, 2024

View reviewed changes

roryabraham removed the request for review from hayata-suenaga February 6, 2024 17:08

roryabraham requested changes Feb 6, 2024

View reviewed changes

roryabraham closed this Feb 7, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: prevent tool tip from filling container #35735

fix: prevent tool tip from filling container #35735

Uh oh!

aswin-s commented Feb 2, 2024 •

edited

Loading

Uh oh!

melvin-bot bot commented Feb 2, 2024

Uh oh!

hayata-suenaga commented Feb 2, 2024

Uh oh!

sobitneupane left a comment

Uh oh!

aswin-s commented Feb 5, 2024

Uh oh!

sobitneupane commented Feb 5, 2024

Uh oh!

aswin-s commented Feb 5, 2024

Uh oh!

sobitneupane commented Feb 5, 2024

Uh oh!

aswin-s commented Feb 5, 2024

Uh oh!

sobitneupane left a comment

Uh oh!

sobitneupane left a comment

Uh oh!

hayata-suenaga commented Feb 5, 2024

Uh oh!

sobitneupane commented Feb 6, 2024

Uh oh!

aswin-s commented Feb 6, 2024

Uh oh!

roryabraham Feb 6, 2024

Uh oh!

roryabraham left a comment

Uh oh!

Uh oh!

		@@ -0,0 +1,5 @@
		import type GetContextMenuItemStyle from './types';

		const getUserListItemStyles: GetContextMenuItemStyle = (styles) => [styles.flex1, styles.flexColumn, styles.justifyContentCenter, styles.alignItemsStretch, styles.optionRow];

fix: prevent tool tip from filling container #35735

fix: prevent tool tip from filling container #35735

Uh oh!

Conversation

aswin-s commented Feb 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Feb 2, 2024

Uh oh!

hayata-suenaga commented Feb 2, 2024

Uh oh!

sobitneupane left a comment

Choose a reason for hiding this comment

Uh oh!

aswin-s commented Feb 5, 2024

Uh oh!

sobitneupane commented Feb 5, 2024

Uh oh!

aswin-s commented Feb 5, 2024

Uh oh!

sobitneupane commented Feb 5, 2024

Uh oh!

aswin-s commented Feb 5, 2024

Uh oh!

sobitneupane left a comment

Choose a reason for hiding this comment

Screenshots/Videos

Uh oh!

sobitneupane left a comment

Choose a reason for hiding this comment

Reviewer Checklist

Uh oh!

hayata-suenaga commented Feb 5, 2024

Uh oh!

sobitneupane commented Feb 6, 2024

Uh oh!

aswin-s commented Feb 6, 2024

Uh oh!

roryabraham Feb 6, 2024

Choose a reason for hiding this comment

Uh oh!

roryabraham left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

aswin-s commented Feb 2, 2024 •

edited

Loading