Ensure correct background is present for `horizontalStackedAvatar` style #13351

marcaaron · 2022-12-06T00:40:58Z

Details

Looks like we want to the border on avatars to be more of a pass through than matching the app background color. Noticed there was a style of appBG being passed to the avatar.

Fixed Issues

$ #13347

Tests

Same as QA

Verify that no errors appear in the JS console

Offline tests

QA Steps

Create a new workspace
Navigate to /settings
Verify that the avatar does not have a black border around it
Hover over the item
Verify the border matches the background of the containing element
Press the item
Verify the border again matches the background of the containing element
Create another workspace
Repeat the previous steps of the test and verify the borders around the avatars match the background colors of the row correctly.
Keep adding more workspaces until the counter for workspaces appears and they are limited to 4 avatars
Verify the borders around the avatars match the background colors of the row correctly.
Locate a workspace chat in the sidebar
Verify the background color around the smaller subscript avatar matches the background of the row
Navigate to the chat
Verify the background color around the smaller subscript avatar matches the lighter background of the row

General regression testing idea: Verify that other avatar styles in the app look correct.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

2022-12-05_15-25-42.mp4

Mobile Web - Chrome

2022-12-05_16-23-46.mp4

Mobile Web - Safari

2022-12-05_16-12-14.mp4

Desktop

2022-12-05_15-58-56.mp4

iOS

2022-12-05_21-01-22.mp4

Android

2022-12-05_16-33-27.mp4

shawnborton · 2022-12-06T00:47:50Z

How does this look with multiple workspaces in the row?

… so that we get the correct overlap effect.

marcaaron · 2022-12-06T01:32:15Z

Updated to cover that case!

Not sure if there is an easier way to do this... but realized we needed to pass the "hover" and "pressed" states so that these borders work correctly. At first, I tried just removing the background color, but this doesn't work very well once you start adding the extra avatars into the mix and need the overlapping border to be solid so it creates the avatar stacking illusion.

marcaaron · 2022-12-06T06:07:29Z

Ah actually noticing that this style will also need to be fixed:

And now thinking it would be better to pass a hover + pressed styles as a prop instead of booleans.

marcaaron · 2022-12-06T06:43:41Z

This also needs to be fixed

marcaaron · 2022-12-06T07:07:16Z

Think this is in a pretty good spot. Gonna open up for reviews / testing.

melvin-bot · 2022-12-06T07:07:52Z

@mananjadhav @MonilBhavsar 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]

shawnborton · 2022-12-06T15:26:31Z

I believe @grgia will handle the overlay (+X) color over in this one

marcaaron · 2022-12-06T17:41:15Z

Ok cool I pushed a fix for it anyway. Maybe we can get @grgia on the review for this one to make sure we are not clashing. 🙏

grgia · 2022-12-07T00:39:13Z

That works, I'll look at this now since I am planning on starting the overlay tonight

grgia · 2022-12-07T01:03:03Z

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:
- iOS / native
- Android / native
- iOS / Safari
- Android / Chrome
- MacOS / Chrome
- 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 was added in all src/languages/* files
- 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 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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

Screen.Recording.2022-12-06.at.5.01.56.PM.mov

iOS

Android

grgia · 2022-12-07T01:16:45Z

I need to restart my computer, gonna take a break and then finish :)

mananjadhav · 2022-12-07T05:45:15Z

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:
- iOS / native
- Android / native
- iOS / Safari
- Android / Chrome
- MacOS / Chrome
- 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 was added in all src/languages/* files
- 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 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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

web-hover-subscript-avatar.mov

Mobile Web - Chrome

mweb-chrome-hover-subscript-avatar.mov

Mobile Web - Safari

mweb-safari-hover-subscript-avatar.mov

Desktop

desktop-hover-subscript-avatar.mov

iOS

ios-hover-subscript-avatar.mov

Android

android-hover-subscript-avatar.mov

grgia

Tests well, code/styling LGTM

OSBotify · 2022-12-07T20:23:48Z

✋ 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 · 2022-12-13T22:38:47Z

🚀 Deployed to production by @chiragsalian in version: 1.2.38-6 🚀

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

Remove appBG from horizontalStackedAvatar

8d6f577

marcaaron self-assigned this Dec 6, 2022

marcaaron added 2 commits December 5, 2022 15:22

Update styles on press/hover

ec4e848

Transparent does not work here for multiple avatars. It must be appBG…

f996fd7

… so that we get the correct overlap effect.

marcaaron changed the title ~~Remove background from horizontalStackedAvatar style~~ Ensure correct background is present for horizontalStackedAvatar style Dec 6, 2022

Clean up styles

3fb7d21

Revert a couple of things and clean up

a09f982

marcaaron marked this pull request as ready for review December 6, 2022 07:07

marcaaron requested a review from a team as a code owner December 6, 2022 07:07

melvin-bot bot requested review from mananjadhav and MonilBhavsar and removed request for a team December 6, 2022 07:07

marcaaron requested a review from grgia December 6, 2022 17:41

mananjadhav approved these changes Dec 7, 2022

View reviewed changes

grgia approved these changes Dec 7, 2022

View reviewed changes

marcaaron merged commit d5d89af into main Dec 7, 2022

marcaaron deleted the marcaaron-fixBorder branch December 7, 2022 20:18

francoisl mentioned this pull request Dec 8, 2022

Deploy Checklist: New Expensify 2022-12-07 #13431

Closed

72 tasks

kavimuru mentioned this pull request Dec 8, 2022

Workspace / Group chat - Black background appears when there are multiple avatars #13446

Closed

melvin-bot bot mentioned this pull request Dec 13, 2022

[HOLD for payment 2022-12-20] Workspace settings: Wrong color for avatar outline when the Workspaces row hovered #13347

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ensure correct background is present for `horizontalStackedAvatar` style #13351

Ensure correct background is present for `horizontalStackedAvatar` style #13351

marcaaron commented Dec 6, 2022 •

edited

Loading

shawnborton commented Dec 6, 2022

marcaaron commented Dec 6, 2022

marcaaron commented Dec 6, 2022

marcaaron commented Dec 6, 2022

marcaaron commented Dec 6, 2022

melvin-bot bot commented Dec 6, 2022

shawnborton commented Dec 6, 2022

marcaaron commented Dec 6, 2022

grgia commented Dec 7, 2022

grgia commented Dec 7, 2022 •

edited by marcaaron

Loading

grgia commented Dec 7, 2022

mananjadhav commented Dec 7, 2022

grgia left a comment

OSBotify commented Dec 7, 2022

OSBotify commented Dec 13, 2022

Ensure correct background is present for horizontalStackedAvatar style #13351

Ensure correct background is present for horizontalStackedAvatar style #13351

Conversation

marcaaron commented Dec 6, 2022 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

shawnborton commented Dec 6, 2022

marcaaron commented Dec 6, 2022

marcaaron commented Dec 6, 2022

marcaaron commented Dec 6, 2022

marcaaron commented Dec 6, 2022

melvin-bot bot commented Dec 6, 2022

shawnborton commented Dec 6, 2022

marcaaron commented Dec 6, 2022

grgia commented Dec 7, 2022

grgia commented Dec 7, 2022 • edited by marcaaron Loading

Reviewer Checklist

Screenshots/Videos

grgia commented Dec 7, 2022

mananjadhav commented Dec 7, 2022

Reviewer Checklist

Screenshots/Videos

grgia left a comment

Choose a reason for hiding this comment

OSBotify commented Dec 7, 2022

OSBotify commented Dec 13, 2022

Ensure correct background is present for `horizontalStackedAvatar` style #13351

Ensure correct background is present for `horizontalStackedAvatar` style #13351

marcaaron commented Dec 6, 2022 •

edited

Loading

grgia commented Dec 7, 2022 •

edited by marcaaron

Loading