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

Fix: Expensify help website color code and caret icons are not updated #17491

Conversation

dukenv0307
Copy link
Contributor

@dukenv0307 dukenv0307 commented Apr 17, 2023

Details

Expensify help website color code and caret icons are not updated

Fixed Issues

$ #17238
PROPOSAL: #17238 (comment)

Tests

Note: This case could be only tested in Web, mobile Web

  1. Go to Expensify help web locally
  2. Verify that LHN background color is "#07271F"
  3. Verify that LHN border color is "#1A3D32"
  4. Verify that LHN text selected is "#E7ECE9"
  5. Verify that arrow-up, arrow-down, arrow-right icon using svg image
  6. Click to Send money in LHN, select any option in Send money page
  7. Verify that icon back-left icon using svg image
  • Verify that no errors appear in the JS console

Offline tests

Same above

QA Steps

Note: This case could be only tested in Web, mobile Web

  1. Go to https://help.expensify.com/
  2. Verify that LHN background color is "#07271F"
  3. Verify that LHN border color is "#1A3D32"
  4. Verify that LHN text selected is "#E7ECE9"
  5. Verify that arrow-up, arrow-down, arrow-right icon using svg image
  6. Click to Send money in LHN, select any option in Send money page
  7. Verify that icon back-left icon using svg image
  • 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 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 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
Screencast.2023-04-19.10.13.07.mp4
Mobile Web - Chrome
Record_2023-04-19-10-13-55.mp4
Mobile Web - Safari
original-37B3A18C-F16D-4666-90E6-A3D5B786F25E.mp4
Desktop

NA

iOS

NA

Android

NA

@dukenv0307 dukenv0307 marked this pull request as ready for review April 17, 2023 08:09
@dukenv0307 dukenv0307 requested a review from a team as a code owner April 17, 2023 08:09
@melvin-bot melvin-bot bot requested review from stitesExpensify and removed request for a team April 17, 2023 08:09
@MelvinBot
Copy link

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

@stitesExpensify
Copy link
Contributor

Adding @Santhosh-Sellavel as C+ since they are the C+ on the issue. Not sure why they weren't auto-assigned...

@Santhosh-Sellavel
Copy link
Collaborator

@dukenv0307 Make sure to the link issue correctly before marking the PR ready for review!

@dukenv0307
Copy link
Contributor Author

dukenv0307 commented Apr 17, 2023

@Santhosh-Sellavel I'm sorry for that. I updated the link issue please check again

@Santhosh-Sellavel
Copy link
Collaborator

Please ensure the same on other PRs as well, because it could affect automations.

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Apr 17, 2023

@Expensify/design Are we good here or missing any changes?

padding-left: 4px;

&.icon-left, &.icon-right, &.icon-up, &.icon-down {
width: 16px;
Copy link
Contributor

Choose a reason for hiding this comment

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

I think these should be 20px. I also think there is probably a cleaner way to do this? Let's create some kind of base icon class that uses 20px for dimensions and uses our standard icon fill color. This way we have one base class instead of needing to repeat these classes so many times.

Copy link
Contributor Author

@dukenv0307 dukenv0307 Apr 18, 2023

Choose a reason for hiding this comment

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

@shawnborton for set color for icon. Actually, I set it by pass fill attr into path in svg file. If you want to use css to set color, I think we could covert our standard icon fill color to filter css. Do you have any solution to set it?

Copy link
Contributor

Choose a reason for hiding this comment

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

We should have a color variable for icons, if not it should be #8B9C8F

Copy link
Contributor

Choose a reason for hiding this comment

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

Good point about how to set these... is there any way to do it via CSS?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@shawnborton I saw that color variable for icons and I used this color to set color of svg icon. Other than filter css, I dont't know other way now.

Copy link
Contributor

Choose a reason for hiding this comment

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

Okay yeah, let's just keep the icons colored as they are then. Thanks!

@shawnborton
Copy link
Contributor

Left a comment. Wow, I had no idea we were using fontawesome before but that was definitely a mistake. Can we rip out all of the other fontawesome references/styles/etc given that we don't need them anymore?

@dukenv0307
Copy link
Contributor Author

@shawnborton Do you want to me replace bars icon that's the only fontawesome icon left by svg

@shawnborton
Copy link
Contributor

Can you show me what that looks like?

@@ -22,7 +22,7 @@

<div class="lhn-header">
<div id="header-button">
<i id="angle-up-icon" class="fa-solid fa-angle-up icon hide"></i>
<img src="/assets/images/arrow-up.svg" class="icon icon-up"></img>
<i id="bars-icon" class="fa-solid fa-bars icon"></i>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@shawnborton that is bars-icon

Copy link
Contributor

Choose a reason for hiding this comment

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

Can you share a screenshot please?

Copy link
Contributor Author

@dukenv0307 dukenv0307 Apr 18, 2023

Choose a reason for hiding this comment

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

@shawnborton bars icon in left

Screenshot 2023-04-18 20:13:33

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah thank you. Yeah, let's use this one instead: menu.svg.zip

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@shawnborton any more problems? If temporarily not available, I'll push code to continue the review

Copy link
Contributor

Choose a reason for hiding this comment

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

I think this is generally looking good. Did border colors get updated too?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@shawnborton I updated border-right-color of LHN is "#1A3D32"

Copy link
Contributor

Choose a reason for hiding this comment

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

Cool, that is correct

@shawnborton
Copy link
Contributor

One thing I am realizing is that it's super hard to understand the color names. Like color-super-dark-green doesn't really mean anything. I would prefer to change the names to reflect their meanings some more, like color-icons or color-highlightBG or color-appBG

Thoughts on something like that? cc @grgia as we've talked about color names before.

@grgia
Copy link
Contributor

grgia commented Apr 18, 2023

@shawnborton yeah let's talk about cleaning up our color naming system as part of the theme-switching project!

@shawnborton
Copy link
Contributor

Ah yeah, good shout @grgia

Comment on lines 218 to 219
nokogiri (1.13.10-x86_64-linux)
racc (~> 1.4)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why we need this changes in this file, seems irrelevant 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.

Sorry I forgot restore after run in local

@@ -3,6 +3,6 @@
<h3 class="title">{{ include.title }}</h3>
</div>
<div class="right-icon">
<i class="fa-solid fa-angle-right icon"></i>
<img src="/assets/images/arrow-right.svg" class="base-icon icon icon"></img>
Copy link
Collaborator

Choose a reason for hiding this comment

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

class name is not correct here

}


Copy link
Collaborator

Choose a reason for hiding this comment

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

Unnecessary Line break

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Santhosh-Sellavel I just fixed it. Please help to check again

@Santhosh-Sellavel
Copy link
Collaborator

@dukenv0307 Can you update the screens in the PR, please?

@shawnborton Are good here any other changes expected here?

@shawnborton
Copy link
Contributor

I think we're good, will confirm once screenshots are updated.

@dukenv0307
Copy link
Contributor Author

@Santhosh-Sellavel I just updated screens in PR, please check again

@@ -286,7 +295,7 @@ button {
#content-area {
display: flex;
flex-direction: column;
background-color: $color-super-dark-green;
background-color: $color-appBG;
Copy link
Contributor

Choose a reason for hiding this comment

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

If we give the body a correct color ($color-appBG) we might not even need this here, but I don't feel strongly.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

should we remove it if give the body a correct color @shawnborton

}
}
}

&__fine-print {
color: $color-gray-green;
color: $color-icons;
Copy link
Contributor

Choose a reason for hiding this comment

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

We should add a new color for this.

The color value is #AFBBB0 and we could name it something like $color-light-gray-green in colors.css

Then in main.scss, we would use $color-text-supporting: $color-light-gray-green

Let me know if that makes sense.

@dukenv0307
Copy link
Contributor Author

@shawnborton I just updated

shawnborton
shawnborton previously approved these changes Apr 20, 2023
@shawnborton
Copy link
Contributor

Okay this feels good to me. All you @grgia @stitesExpensify @Santhosh-Sellavel

@Santhosh-Sellavel
Copy link
Collaborator

Up & Menu buttons are both shown at the same time, only one should be present at a time

Screen.Recording.2023-04-21.at.4.08.46.AM.mov

@dukenv0307

@dukenv0307
Copy link
Contributor Author

@Santhosh-Sellavel I missed class and id when change to svg. I updated, please help to check again

@Santhosh-Sellavel
Copy link
Collaborator

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 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(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 reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
Screen.Recording.2023-04-22.at.1.54.13.AM.mov
Mobile Web - Chrome
Screen_Recording_20230422_020822_Chrome.mp4
Mobile Web - Safari
Simulator.Screen.Recording.-.iPhone.14.-.2023-04-22.at.01.55.07.mp4

@Santhosh-Sellavel
Copy link
Collaborator

@grgia Not sure shouldn't this be internal QA?

@Santhosh-Sellavel
Copy link
Collaborator

Screen_Recording_20230422_020916_Chrome.mp4

Selection fill is a bit off in mWeb in Android, should we do something about it @shawnborton? If so let's create a new bug to handle it let me know if needs to be reported thanks!

Copy link
Collaborator

@Santhosh-Sellavel Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

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

Looks good to me tests well, thanks!

cc: @puneetlath

Copy link
Contributor

@puneetlath puneetlath left a comment

Choose a reason for hiding this comment

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

Oh interesting. Not sure why I didn't get auto-assigned to this PR.

In any case, thanks for doing all the legwork everyone! It looks good to me too. Let's wait for @shawnborton's approval though before merging.

@dukenv0307
Copy link
Contributor Author

@shawnborton please help to check again and approval the PR

@dukenv0307
Copy link
Contributor Author

@stitesExpensify Please help to check and approval the PR

@Santhosh-Sellavel
Copy link
Collaborator

Bump @shawnborton

@shawnborton
Copy link
Contributor

Colors look good to me.

Did we ever fix the bug where both the menu icon and the caret icon show at the same time?

@dukenv0307
Copy link
Contributor Author

dukenv0307 commented Apr 24, 2023

@shawnborton This bug is reported by @Santhosh-Sellavel and I fixed it after the report

@shawnborton
Copy link
Contributor

Cool, all good on my end. @stitesExpensify all you!

@puneetlath
Copy link
Contributor

Gonna go ahead and merge since we have a good amount of approvals here.

@puneetlath puneetlath merged commit d8622b0 into Expensify:main Apr 24, 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/puneetlath in version: 1.3.5-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.5-6 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 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