Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: added descriptive text for tooltips #17321

Merged
merged 4 commits into from
Apr 18, 2023

Conversation

allroundexperts
Copy link
Contributor

@allroundexperts allroundexperts commented Apr 12, 2023

Details

This PR removes the inconsistency where the description text was being shown for the tooltip on mobile screens only.

Fixed Issues

$ #16521
PROPOSAL: #16521 (comment)

Tests

  1. Open mweb and Go to settings -> about
  2. Go to App download links
  3. Long press any (andriod/ios/mac) given links and notice the Copy URL popup with link shown.
  4. Repeat step 1 to 4 and notice that in web, Copy URL popup doesn’t show url
  5. Verify that the Copy URL popup shows the copied URL after this change
  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

  1. Open mweb and Go to settings -> about
  2. Go to App download links
  3. Long press any (andriod/ios/mac) given links and notice the Copy URL popup with link shown.
  4. Repeat step 1 to 4 and notice that in web, Copy URL popup doesn’t show url
  5. Verify that the Copy URL popup shows the copied URL after this change
  • 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 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 correct English and 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 Screenshot 2023-04-17 at 12 08 12 AM
Mobile Web - Chrome
Screen.Recording.2023-04-12.at.5.14.59.AM.mov
Mobile Web - Safari
Screen.Recording.2023-04-12.at.5.13.54.AM.mov
Desktop
Screen.Recording.2023-04-12.at.5.12.16.AM.mov
iOS
Screen.Recording.2023-04-12.at.5.13.26.AM.mov
Android Screenshot 2023-04-17 at 12 15 38 AM

@allroundexperts allroundexperts marked this pull request as ready for review April 12, 2023 09:45
@allroundexperts allroundexperts requested a review from a team as a code owner April 12, 2023 09:45
@melvin-bot melvin-bot bot requested review from cead22 and sobitneupane and removed request for a team April 12, 2023 09:45
@MelvinBot
Copy link

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

@allroundexperts
Copy link
Contributor Author

@shawnborton The max width here for the tooltip is 500px. Please let me know if this needs to be tweaked.

@shawnborton
Copy link
Contributor

The tooltip width is fine, but the context menu (right-click menu) could be smaller, let's try 375px and then maybe we need to truncate the URL after two lines so it doesn't get too messy?

@shawnborton shawnborton self-requested a review April 12, 2023 13:00
@allroundexperts

This comment was marked as outdated.

@shawnborton
Copy link
Contributor

That feels a bit wider than 375px to me, can you confirm?

@allroundexperts
Copy link
Contributor Author

@shawnborton You were correct. The padding wasn't being accounted for. I've fixed it. Here's how it looks:
Screenshot 2023-04-13 at 1 22 28 AM

@shawnborton
Copy link
Contributor

Much better.

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshots/Videos

Web Screenshot 2023-04-13 at 13 30 11 Screenshot 2023-04-13 at 13 28 57
Screen.Recording.2023-04-13.at.13.27.43.mov
Mobile Web - Chrome
Screen.Recording.2023-04-13.at.13.36.53.mov
Mobile Web - Safari
Screen.Recording.2023-04-13.at.13.43.43.mov
Desktop
Screen.Recording.2023-04-13.at.13.32.58.mov
iOS
Screen.Recording.2023-04-13.at.13.45.03.mov
Android
Screen.Recording.2023-04-13.at.13.38.34.mov

sobitneupane
sobitneupane previously approved these changes Apr 13, 2023
Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 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 correct English and 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 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.

@@ -86,6 +86,7 @@ const MenuItem = (props) => {
styles.popoverMenuItem,
StyleUtils.getButtonBackgroundColorStyle(getButtonState(props.focused || hovered, pressed, props.success, props.disabled, props.interactive), true),
..._.isArray(props.wrapperStyle) ? props.wrapperStyle : [props.wrapperStyle],
styles.popoverMaxWidth,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of curiosity, why add this style here instead of to descriptionTextStyle like you suggested in the proposal?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding width of 375px to the descriptionTextStyle would not take into account the padding that is on this container. This will cause the issue highlighted by @shawnborton here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can set the width of descriptionTextStyle to be 375px - padding on container. That will solve the issue as well but I found the above approach to be more cleaner.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That makes sense, and I agree this is cleaner, thanks!

cead22
cead22 previously approved these changes Apr 13, 2023
@cead22
Copy link
Contributor

cead22 commented Apr 13, 2023

@allroundexperts @sobitneupane it looks like we're truncating the URL too much, since there's still a lot of space to put in more characters before we need to show the .... Is that by design or is it something we should fix in this PR?
image
image

@allroundexperts
Copy link
Contributor Author

@allroundexperts @sobitneupane it looks like we're truncating the URL too much, since there's still a lot of space to put in more characters before we need to show the .... Is that by design or is it something we should fix in this PR? image image

@cead22 This is how the Text component behaves when numberOfLines is set. Without setting this property, this is how it looks:
Screenshot 2023-04-14 at 2 22 17 AM

It seems like that a - in the url breaks the link onto the next line. Since we're showing 2 lines only, it shows the text till -. I'm not sure if this is a bug. More so, This doesn't look like its related to this PR.

@cead22
Copy link
Contributor

cead22 commented Apr 14, 2023

You're right that this isn't happening due to a change in this PR, but since this PR is trying to improve this menu specifically for URLs, and URLs are kinda breaking it, I think it's worth seeing if we can solve that here.

Is there a way to make Text not break on -? or a different component that behaves like Text without that line-break logic?

@allroundexperts
Copy link
Contributor Author

You're right that this isn't happening due to a change in this PR, but since this PR is trying to improve this menu specifically for URLs, and URLs are kinda breaking it, I think it's worth seeing if we can solve that here.

Is there a way to make Text not break on -? or a different component that behaves like Text without that line-break logic?

Sure. I'll investigate a fix for this as well.

@allroundexperts
Copy link
Contributor Author

@cead22 Pushed a fix. We were using break-word for breaking words (which was causing the text to break to next line when it encountered a hyphen). I changed it to break-all which breaks to the next line at any character.

@cead22
Copy link
Contributor

cead22 commented Apr 14, 2023

Awesome, thank you! Can you update one of your test videos to show this is working as intended? The only one I see that has a link with a dash is the Android one, which is the last one in your list. But since that was uploaded before this commit, I'm guessing that problem wasn't happening on android, and maybe it was a problem specific to web, in which case it'd be good to see that a - doesn't make the URL break into a new line

This can also be done in the reviewer checklist

@allroundexperts
Copy link
Contributor Author

@cead22 Updated web and android screenshots as suggested.

@shawnborton
Copy link
Contributor

Visually looks good to me, @cead22 feel free to merge

@cead22 cead22 merged commit 8864416 into Expensify:main Apr 18, 2023
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

🚀 Deployed to staging by https://github.com/cead22 in version: 1.3.2-0 🚀

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

mountiny added a commit that referenced this pull request Apr 20, 2023
This reverts commit 8864416, reversing
changes made to 2bacd2b.
@mountiny
Copy link
Contributor

Sorry I had to revert this PR to push daily deploys #17739 it is linked ot deploy blockers and the fix PR is not ready to be merged/CPed #17640

luacmartins added a commit that referenced this pull request Apr 20, 2023
Revert "Merge pull request #17321 from allroundexperts/fix-16521"
OSBotify pushed a commit that referenced this pull request Apr 20, 2023
Revert "Merge pull request #17321 from allroundexperts/fix-16521"

(cherry picked from commit 56afc48)
@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.2-5 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/cead22 in version: 1.3.3-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.3-2 🚀

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

@mollfpr mollfpr mentioned this pull request Apr 22, 2023
55 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants