Add tooltip and change background color of subscription icon

[dukenv0307]

Details

Fixed Issues

$ #35618
PROPOSAL: #35618 (comment)

Tests

1. Hover over the workspace switch button
2. Verify that the tooltip appears with the text is Choose a workspace
3. Verify that the background color of subscription is changed

• Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

1. Hover over the workspace switch button
2. Verify that the tooltip appears with the text is Choose a workspace
3. Verify that the background color of subscription is changed

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

Screenshots/Videos

Android: Native

Android: mWeb Chrome

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

iOS: Native

iOS: mWeb Safari

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

MacOS: Chrome / Safari

Screen.Recording.2024-02-06.at.22.28.57.mov

MacOS: Desktop

Screen.Recording.2024-02-06.at.22.32.25.mov

[melvin-bot]

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

[dukenv0307]

@shawnborton Can you please confirm the bg color of the subscription icon here? Actually, SubscriptAvatar doesn't support to change the background color of subscription icon. We can only change the background color of border.

1. If the screenshot I uploaded is the current expected behavior. We're good now.
2. If we want to change the bg color instead of background color of border, I will update the PR to add an extra prop in SubscriptAvatar to support changing bg color of subscription icon.

[shawnborton]

I am a bit confused here, what is the subscription icon?

In your video though, why are you changing the border color of the small button over the workspace icon?

Think of the small circular button that is on top of the workspace avatar as just a button. A default button. We want to use the same existing styles of default buttons here, so that means just changing the background color on hover as well as a pressed state.

[shawnborton]

Also, it looks like something changed with the border color too? The button should have a border around it like this:

[allgandalf]

hello @dukenv0307 @shawnborton, I think what you intended to do with the button is mentioned in my Proposal for the issue, this changed the button bg color over hover rather than the icon bg color, I would have no issue if @dukenv0307 uses the same solution over this PR for the bg color :), would like to share the bounty amount equally if @dukenv0307 cannot be unassigned

simplescreenrecorder-2024-02-04_02.06.03.mp4

[shawnborton]

Yup @GandalfGwaihir that indeed looks like what we expect the behavior to be here, thanks for the video!

[shawnborton]

cc @thesahindia @mountiny for thoughts here - I think we picked an incorrect proposal and it looks like @GandalfGwaihir's proposal was actually what we were looking for.

[dukenv0307]

If we want to change the bg color instead of background color of border, I will update the PR to add an extra prop in SubscriptAvatar to support changing bg color of subscription icon.

@shawnborton Actually SubscriptAvatar doesn't change the bg color of the subscription icon when we hover over it. So as I mentioned above we can add an extra prop like subscriptionContainerStyle and use this to flex the style of container of subscription container view instead of having a constant bg color when we hover over this because SubscriptAvatar is used in many places of the app.

[shawnborton]

What exactly is SubscriptAvatar? I don't think I understand the name of that.

And I don't think I am following the rest of your comment. All I am trying to communicate is that this part here:

It's just a small default button, and it should behave just like other buttons regarding :hover and :press.

[mountiny]

cc @hayata-suenaga seems like is assigned, I was not involved so do not have context behind picked proposal

[dukenv0307]

@shawnborton

What exactly is SubscriptAvatar? I don't think I understand the name of that.

This is a component that we used to display the avatar like workspace switcher button.

In this component, we called the big icon (workspace avatar in this case) is main avatar and we called the small icon (small button in this case) is subscription icon.

It's just a small default button, and it should behave just like other buttons regarding :hover and :press.

And in this component we simply render the subscription in a view and has no effect like :hover.

App/src/components/SubscriptAvatar.tsx

Line 105 in 0eb6d02

<View

cc @thesahindia @mountiny for thoughts here - I think we picked an incorrect proposal and it looks like @GandalfGwaihir's proposal was actually what we were looking for.

When I post the proposal, I follow the description of the bug and after that we re-confirm again the expected behavior and it's different from the description of the bug but it's easily to do.

I just want to re-confirm here #35795 (comment) because maybe we don't want to re-create a new prop in this component.

[shawnborton]

SubscriptAvatar - This is a component that we used to display the avatar like workspace switcher button.

@mountiny @kosmydel any context why we named it this way? This really has nothing to do with your subscription... internally we've always referenced this as the WorkspaceSwitcher too.

Either way, yes, the small button inside of the workspace switcher is just a button and it should have :hover and :press functionality like all of our other buttons. Hopefully that helps clear things up, curious what you think the next steps are from here.

[mountiny]

This really has nothing to do with your subscription... internally we've always referenced this as the WorkspaceSwitcher too.

@shawnborton Its not subscription but subscript since you have the small icon on right bottom. like this in maths or chemistry:

[shawnborton]

Ah, got it. Wow... that still feels like quite the stretch of a name? Why not name it something more friendly like AvatatarWithArrowButton or something? I guess that's a different conversation for a different day...

[kosmydel]

Ah, got it. Wow... that still feels like quite the stretch of a name? Why not name it something more friendly like AvatatarWithArrowButton or something? I guess that's a different conversation for a different day...

This component was created two years ago. Probably we just reused it (I wasn't author of this change).

[allgandalf]

where do we go from here 🤔

[dukenv0307]

Why not name it something more friendly like AvatatarWithArrowButton or something

The reason can be the aim of this component to display two avatars like this. Not for the case the subscription is icon button.

[dukenv0307]

I think we have two options here

1. Still re-use SubscriptAvatar, add an extra prop to change the bg color of the small icon

2. Create a new component like AvatarWithIconButton and in this component, the small icon style will be the same style as the normal icon. And the icon button can be flexed to re-use in the feature not only arrow button.

@shawnborton What do you think?

[shawnborton]

Cool, I don't feel too strongly from a technical perspective - definitely curious what the C+/engineers think about for that.

[allgandalf]

Either way, yes, the small button inside of the workspace switcher is just a button and it should have :hover and :press functionality like all of our other buttons

with the intented goal in mind, i guess my proposal might be a fit :) to this bug @shawnborton @hayata-suenaga @thesahindia
would be okay to share the bounty amount equally if @dukenv0307 cannot be unassigned

[mountiny]

As noted it was around for a while. I agree that AvatarWithSubscript would be cleaner.

[dukenv0307]

@thesahindia Updated the PR to use an extra style prop.

[hayata-suenaga]

I don't think we need additional component just to add the hover effect. Let's stick with the chosen proposal and add an extra prop.

[thesahindia]

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.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

[thesahindia]

LGTM!

[hayata-suenaga]

🟢

[hayata-suenaga]

building ad hoc build so that Shawn can check the final design

[github-actions]

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

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

---

👀 View the workflow run that generated this build 👀

[shawnborton]

I think that looks good to me! Thanks!

[OSBotify]

✋ 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]

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.4.40-0 🚀

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

[OSBotify]

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

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