Skip to content

[Desktop Navigation] Add a tooltip to the account switcher on the accounts page #59713

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

Conversation

WojtekBoman
Copy link
Contributor

@WojtekBoman WojtekBoman commented Apr 7, 2025

Explanation of Change

This PR adds a tooltip to the account switcher, when we hover over the account switcher icon it will be displayed

Fixed Issues

$ #59373
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console
  1. Verify if the tooltip is displayed when the account switcher icon is hovered.

Offline tests

  1. Verify if the tooltip is displayed when the account switcher icon is hovered.

QA Steps

  • Verify that no errors appear in the JS console
  1. Verify if the tooltip is displayed when the account switcher icon is hovered.

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

MacOS: Chrome / Safari

Screenshot 2025-04-07 at 09 04 24

Screenshot 2025-04-07 at 08 56 31

MacOS: Desktop Screenshot 2025-04-07 at 08 48 01 Screenshot 2025-04-07 at 08 56 59

@WojtekBoman
Copy link
Contributor Author

@flaviadefaria @mountiny @Expensify/design

Could you generate builds for this one? And I'd like to ask if it should be hidden behind the beta as it's a minor change

@shawnborton
Copy link
Contributor

I can run a quick build. I feel like this is a change that would benefit all current users who use copilot, so I can see where it doesn't need to be behind the beta flag.

Copy link
Contributor

github-actions bot commented Apr 7, 2025

🚧 @shawnborton has triggered a test app build. You can view the workflow run here.

This comment has been minimized.

@WojtekBoman WojtekBoman marked this pull request as ready for review April 7, 2025 08:40
@WojtekBoman WojtekBoman requested a review from a team as a code owner April 7, 2025 08:40
@melvin-bot melvin-bot bot requested a review from dukenv0307 April 7, 2025 08:40
Copy link

melvin-bot bot commented Apr 7, 2025

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

@melvin-bot melvin-bot bot removed the request for review from a team April 7, 2025 08:40
@flaviadefaria
Copy link
Contributor

Looks great! Since this isn't directly related to the LHB changes, I think we can merge and deploy without adding it to the beta - as this would add immediate value to users.

image

@dukenv0307
Copy link
Contributor

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 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 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 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari Screenshot 2025-04-07 at 20 35 07
MacOS: Desktop Screenshot 2025-04-07 at 20 39 52

Copy link
Contributor

@dukenv0307 dukenv0307 left a comment

Choose a reason for hiding this comment

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

LGTM

@melvin-bot melvin-bot bot requested a review from mountiny April 7, 2025 13:40
@dannymcclain
Copy link
Contributor

Definitely agree this doesn't need to be behind the beta.

But quick question: should we make the tooltip show up when hovering over any part of that account row? This is the clickable area that opens the menu:
CleanShot 2025-04-07 at 08 36 14@2x

But currently you have to hover specifically over the icon to get the tooltip to pop up.

CleanShot 2025-04-07 at 08 36 53

I kinda think we should scoot the tooltip down a little bit and trigger it when hovering over any part of the tappable area for that row.

We ended up adjusting the educational tooltip to point more at the avatar to get more predictable spacing, should we do something like that here too? Or just center the tooltip with the tappable area?

CleanShot 2025-04-07 at 08 41 47@2x

CleanShot 2025-04-07 at 08 42 47@2x

Sorry to be switching things up—just want to make sure this tooltip is actually useful. @Expensify/design for thoughts.

@shawnborton
Copy link
Contributor

I kinda think we should scoot the tooltip down a little bit and trigger it when hovering over any part of the tappable area for that row.

I definitely agree with this.

We ended up adjusting the educational tooltip to point more at the avatar to get more predictable spacing, should we do something like that here too? Or just center the tooltip with the tappable area?

I think that's a solid idea too. I quite like the one on the left so it matches the educational version.

@dannymcclain
Copy link
Contributor

I quite like the one on the left so it matches the educational version.

Sounds good to me!

@mountiny
Copy link
Contributor

mountiny commented Apr 7, 2025

Sounds like we would like to move the tooltip position and behaviour slightly so going to wait for @WojtekBoman to address that before merging

@WojtekBoman
Copy link
Contributor Author

I adjusted the tooltip position, you can run new builds and check if it is ok now :)

Here's a screenshot of how it looks now:
image

cc: @flaviadefaria @Expensify/design

@shawnborton
Copy link
Contributor

It looks like the pointer isn't connected to the tooltip body... is that maybe because you are zoomed out?
CleanShot 2025-04-08 at 08 46 28@2x

I can run a build though for testing.

Copy link
Contributor

github-actions bot commented Apr 8, 2025

🚧 @shawnborton has triggered a test app build. You can view the workflow run here.

Copy link
Contributor

github-actions bot commented Apr 8, 2025

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖 iOS 🍎
Android 🤖🔄 iOS 🍎🔄
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/59713-hybrid/index.html https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/59713-hybrid/index.html
Android iOS
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/59713/NewExpensify.dmg https://59713.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@WojtekBoman
Copy link
Contributor Author

I added one more fix, the tooltip is displayed only when users can switch accounts
cc: @Expensify/design

@flaviadefaria
Copy link
Contributor

I added one more fix, the tooltip is displayed only when users can switch accounts

Ah, great one!

@flaviadefaria
Copy link
Contributor

@shawnborton @dannymcclain how do you feel about the tooltip displaying on top of Accounts? Also since this is a permanent tooltip would it make sense to remove the bottom/up arrows at some point -- they seem a little useless if we never point at them.

image

@shawnborton
Copy link
Contributor

I think the arrows should stay, because they are a visual indicator that that particular element is interactive.

I think the tooltip is fine personally, but curious what the other designers think!

@dannymcclain
Copy link
Contributor

I think the arrows should stay, because they are a visual indicator that that particular element is interactive.
I think the tooltip is fine personally, but curious what the other designers think!

Agree with both comments! I think the the up-down-arrows signal that you should/can hover over this element, and the tooltip explains what it is you're hovering over.

And IMO no worries about the tooltip covering the Account label—since tooltips are temporary that's no big deal.

@WojtekBoman I'm sorry to be such a nit picker, but can we scoot the tooltip over a tiny bit so that the arrow is more centered with the avatar?
CleanShot 2025-04-08 at 07 57 28

CleanShot 2025-04-08 at 08 01 29@2x

@WojtekBoman
Copy link
Contributor Author

WojtekBoman commented Apr 8, 2025

I think the arrows should stay, because they are a visual indicator that that particular element is interactive.
I think the tooltip is fine personally, but curious what the other designers think!

Agree with both comments! I think the the up-down-arrows signal that you should/can hover over this element, and the tooltip explains what it is you're hovering over.

And IMO no worries about the tooltip covering the Account label—since tooltips are temporary that's no big deal.

@WojtekBoman I'm sorry to be such a nit picker, but can we scoot the tooltip over a tiny bit so that the arrow is more centered with the avatar?

I fixed that, please verify if it looks good now :)

@dannymcclain
Copy link
Contributor

@WojtekBoman Thank you! Can you grab a screenshot so I don't have to run another build?

@WojtekBoman
Copy link
Contributor Author

@WojtekBoman Thank you! Can you grab a screenshot so I don't have to run another build?

Sure :)
image

@dannymcclain
Copy link
Contributor

:chef-kiss: Looks good to me!

@dukenv0307
Copy link
Contributor

Screenshot 2025-04-08 at 20 32 50 LGTM

@dukenv0307
Copy link
Contributor

There's a failed test

@WojtekBoman WojtekBoman force-pushed the improve-desktop-nav/account-switcher-tooltip branch from d104d8c to f8dc1e4 Compare April 8, 2025 13:41
@WojtekBoman
Copy link
Contributor Author

There's a failed test

Merged the latest main, I hope it will work now🤞

@flaviadefaria
Copy link
Contributor

I still find it weird that the tooltip covers Account and, at the same time, the top pointer is so far from the avatar. I'd be in favor of moving the tooltip up a bit more up so that it looks better all around but I'll defer to the design gurus 😅

Copy link
Contributor

github-actions bot commented Apr 8, 2025

🚧 @mountiny has triggered a test app build. You can view the workflow run here.

Copy link
Contributor

github-actions bot commented Apr 8, 2025

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖 iOS 🍎
Android 🤖🔄 iOS 🍎🔄
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/59713-hybrid/index.html https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/59713-hybrid/index.html
Android iOS
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/59713/NewExpensify.dmg https://59713.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@mountiny
Copy link
Contributor

mountiny commented Apr 8, 2025

For final testing. @dukenv0307 if you could double check this please

@dukenv0307
Copy link
Contributor

@mountiny Code looks good and tests well

Screenshot 2025-04-09 at 01 30 07

@dukenv0307
Copy link
Contributor

But I think we're waiting for @Expensify/design team to resolve this comment

@mountiny
Copy link
Contributor

mountiny commented Apr 8, 2025

Yeah sounds good, just wanted to confirm the behaviour for now. Lets wait for the final design confirmation @dannymcclain

@dannymcclain
Copy link
Contributor

I still find it weird that the tooltip covers Account and, at the same time, the top pointer is so far from the avatar. I'd be in favor of moving the tooltip up a bit more up so that it looks better all around but I'll defer to the design gurus 😅

I'm fine with moving it up a bit if we want, but I think it's the standard 8px away from the element. The tooltip covering the Account label is not weird to me at all—the nature of tooltips is that they're supposed to sit on top of everything to draw focus. Here's a random example from MacOS:
CleanShot 2025-04-08 at 14 47 48@2x

Curious if anyone else from @Expensify/design has anything else to add though!

@dubielzyk-expensify
Copy link
Contributor

Curious if anyone else from @Expensify/design has anything else to add though!

Aligned with Danny here. 8px below and sitting on top of the content is correct. As long as the arrow points to the element as well 👍

@shawnborton
Copy link
Contributor

Me three, that 8px gap is our standard distance away from something. I don't find it odd because it's something that launches only on hover. All of our tooltips inevitably cover something up when you see them on hover, I don't think we can really avoid that.

@mountiny
Copy link
Contributor

mountiny commented Apr 9, 2025

Sounds like the great triumvirate is aligned on this one so I will review and merge if all looks good now

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

LGTM, thank you!

@mountiny mountiny merged commit d3d6795 into Expensify:main Apr 9, 2025
16 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Apr 9, 2025

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

@flaviadefaria
Copy link
Contributor

The gurus have spoken 😄

Copy link
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 9.1.26-0 🚀

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

Copy link
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.1.26-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
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants