Skip to content

Add close button to product training tooltips and track dismissal method#58666

Merged
puneetlath merged 20 commits intoExpensify:mainfrom
ishpaul777:add-x-in-tooltip
Mar 21, 2025
Merged

Add close button to product training tooltips and track dismissal method#58666
puneetlath merged 20 commits intoExpensify:mainfrom
ishpaul777:add-x-in-tooltip

Conversation

@ishpaul777
Copy link
Contributor

@ishpaul777 ishpaul777 commented Mar 18, 2025

Explanation of Change

Fixed Issues

$ #58663
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console
    Same as QA

Offline tests

QA Steps

  • Verify that no errors appear in the JS console
  1. Sign in with new account on ND.
  2. Verify you see a tooltip on FAB button, verify there is 'x' to dismiss the tooltip.
  3. verify clicking on tooltip will dismiss tooltip.
  4. Verify all other tooltips has 'x' to dismiss the tooltip

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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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.ts 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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
Screen.Recording.2025-03-21.at.2.12.33.AM.mov
Android: mWeb Chrome
Screen.Recording.2025-03-21.at.3.39.11.AM.mov
iOS: Native
Screen.Recording.2025-03-21.at.3.39.11.AM.mov
iOS: mWeb Safari Screenshot 2025-03-21 at 12 45 33 AM
MacOS: Chrome / Safari Screenshot 2025-03-21 at 12 17 33 AM
MacOS: Desktop Screenshot 2025-03-21 at 1 05 33 AM

Copy link
Contributor Author

@ishpaul777 ishpaul777 Mar 18, 2025

Choose a reason for hiding this comment

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

todo: need to change image asset

@ishpaul777
Copy link
Contributor Author

@Expensify/design Can i please get this 'x' icon svg asset 🙇

Screenshot 2025-03-19 at 11 23 25 PM

@dannymcclain
Copy link
Contributor

@ishpaul777 it's just our standard Close icon: App/assets/images/close.svg (just sized a bit smaller than normal)

@ishpaul777
Copy link
Contributor Author

it's just our standard Close icon: App/assets/images/close.svg (just sized a bit smaller than normal)

Thanks! I added width and height for 12px, let me know if this looks good : )

Screenshot 2025-03-20 at 12 53 29 AM

@dannymcclain
Copy link
Contributor

Yeah looks good! 👍

@shawnborton
Copy link
Contributor

Looking good! Only minor comment I have... do we want to make any kind of optical adjustments on the right side's padding so that the x icon is closer to the edge? From Figma, I had toyed with using 12px of padding just for the right side, whereas the other sides get 16px. Thoughts @Expensify/design? I don't feel strongly here, happy to just keep it simple and use 16px for all sides.

CleanShot 2025-03-19 at 18 22 59@2x

@dubielzyk-expensify
Copy link
Contributor

Yeah, I'm kinda with you. In general when it comes to adding icons I always prefer reduction of the padding by 4px. We have this on our icon buttons too. The only thing that makes me hesitate is that the padding is so consistent in all the horizontal areas of the tooltip:

CleanShot 2025-03-20 at 10 31 42@2x

Happy to try it, but I suspect we'll then wanna tweak some of the other spacing. Cause to me the screenshot you have above looks a bit unbalanced in terms of padding.

@shawnborton
Copy link
Contributor

shawnborton commented Mar 20, 2025

Good point - if anything, I could see just doing 12px padding everywhere?
CleanShot 2025-03-20 at 08 10 13@2x

@dannymcclain
Copy link
Contributor

I don't have strong feelings. Though I do kinda like your 12px everywhere idea Shawn.

@ishpaul777
Copy link
Contributor Author

Added 12px for gap and padding, Screenshot:

Screenshot 2025-03-21 at 12 17 33 AM

@parasharrajat
Copy link
Member

Please fix the checklist as well.

@parasharrajat
Copy link
Member

parasharrajat commented Mar 20, 2025

Screenshots

🔲 iOS / native

🔲 iOS / Safari

21.03.2025_03.32.55_REC.mp4

🔲 MacOS / Desktop

21.03.2025_03.46.48_REC.mp4

🔲 MacOS / Chrome

21.03.2025_03.09.46_REC.mp4

🔲 Android / Chrome

21.03.2025_03.16.00_REC.mp4

🔲 Android / native

21.03.2025_04.15.45_REC.mp4

@parasharrajat
Copy link
Member

IOS is crashing for some reason. @ishpaul777 did you notice that too?

@ishpaul777
Copy link
Contributor Author

iOS standalone app build also failing for me, i had to build iOS hybrid app to test

Copy link
Member

@parasharrajat parasharrajat 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: 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.

🎀 👀 🎀 C+ reviewed

@parasharrajat
Copy link
Member

I am approving this as the crash is also happening on the main branch as well.

@puneetlath puneetlath merged commit 32e8f6d into Expensify:main Mar 21, 2025
17 of 18 checks passed
@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.

@github-actions
Copy link
Contributor

🚀 Deployed to staging by https://github.com/puneetlath in version: 9.1.17-0 🚀

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

cristipaval added a commit that referenced this pull request Mar 24, 2025
This reverts commit 32e8f6d, reversing
changes made to 7e09fcf.
ishpaul777 added a commit to ishpaul777/App that referenced this pull request Mar 24, 2025
@cristipaval
Copy link
Contributor

FYI, this PR was reverted

@github-actions
Copy link
Contributor

🚀 Deployed to production by https://github.com/cristipaval in version: 9.1.17-1 🚀

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

@github-actions
Copy link
Contributor

🚀 Deployed to staging by https://github.com/puneetlath in version: 9.1.18-0 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 cancelled 🔪
🕸 web 🕸 success ✅
🤖🔄 android HybridApp 🤖🔄 cancelled 🔪
🍎🔄 iOS HybridApp 🍎🔄 cancelled 🔪

@github-actions
Copy link
Contributor

🚀 Deployed to production by https://github.com/cristipaval in version: 9.1.18-4 🚀

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

puneetlath added a commit that referenced this pull request Mar 31, 2025
Add close button to product training tooltips and track dismissal method #58666
@github-actions
Copy link
Contributor

github-actions bot commented Apr 1, 2025

🚀 Deployed to staging by https://github.com/puneetlath in version: 9.1.22-0 🚀

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

@github-actions
Copy link
Contributor

github-actions bot commented Apr 3, 2025

🚀 Deployed to production by https://github.com/grgia in version: 9.1.22-10 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

DeployBlockerCash This issue or pull request should block deployment Ready To Build

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants