Skip to content

Add Light Theme light.js and clean up colors.js #22986

Merged
grgia merged 31 commits intomainfrom
georgia-addLightTheme
Sep 15, 2023
Merged

Add Light Theme light.js and clean up colors.js #22986
grgia merged 31 commits intomainfrom
georgia-addLightTheme

Conversation

@grgia
Copy link
Contributor

@grgia grgia commented Jul 17, 2023

Details

In this PR, I am adding a V1 of our light theme as well as doing a first pass clean up of our colors.js file.

  • Added all of our brand colors as well as the new theme colors to color.js
  • created a new file light.js to house the new light theme.
  • Renamed the dark mode color keys from green____ to dark____ to match the theme name.
    • i.e greenIcons -> darkIcons
  • Removed a few rogue colors (not in our design system) i.e. greenborderLighter, blueTextPreview
  • Removed most duplicate color keys in colors.js
  • Removed an old, unused function getLoginPagePromoStyle() that was referencing old colors

Fixed Issues

$ #21016

Tests

  • Verify that no errors appear in the JS console

To Test V1 of Light Mode:

  • Add import lightTheme from './light'; and change the export to lightTheme in default.js

  • We created a test branch with the above and had the build QA'd here - QA Light Theme #23158
    This will be QA'd again when we actually release it

  • Verify that no errors appear in the JS console

To test the color changes (removed color keys) in dark theme:

  • Visually QA tooltips
image image
  • Visually QA Skeleton UI
  • Visually QA Switch
image

Offline tests

QA Steps

  • Verify that no errors appear in the JS console

To test the color changes (removed color keys) in dark theme:

  • Visually QA tooltips
image image
  • Visually QA Skeleton UI
  • Visually QA Switch
image

No light theme QA, will be done when theme switching is live.

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 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 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • 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
Dark Light
image HERE
Mobile Web - Chrome
Dark Light
HERE HERE
Mobile Web - Safari
Dark Light
HERE HERE
Desktop
Dark Light
HERE HERE
iOS
Dark Light
HERE HERE
Android
Dark Light
image HERE

@grgia grgia self-assigned this Jul 17, 2023
@grgia
Copy link
Contributor Author

grgia commented Jul 17, 2023

@shawnborton

Screen.Recording.2023-07-17.at.10.11.26.AM.mov

I've added the light theme V1 in this PR. I think the main tweaks we may make to the theme are in the hovers / icon hovers.

We can either QA this with this PR or QA when we go live- do you have the bandwidth to do a first pass of the theme to see if there's anything that needs to be tweaked? I can send screenshots as needed

@shawnborton
Copy link
Contributor

Are you able to spin up a test build so I can test it locally?

@grgia grgia mentioned this pull request Jul 19, 2023
58 tasks
@grgia grgia marked this pull request as ready for review August 3, 2023 16:08
@grgia grgia requested a review from a team as a code owner August 3, 2023 16:08
@melvin-bot melvin-bot bot requested review from thesahindia and removed request for a team August 3, 2023 16:08
@OSBotify
Copy link
Contributor

@melvin-bot
Copy link

melvin-bot bot commented Sep 14, 2023

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

@grgia
Copy link
Contributor Author

grgia commented Sep 14, 2023

Tests pass on adhoc build

@grgia grgia requested a review from a team September 14, 2023 10:07
@melvin-bot melvin-bot bot requested review from thesahindia and removed request for a team September 14, 2023 10:07
@melvin-bot
Copy link

melvin-bot bot commented Sep 14, 2023

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

@grgia
Copy link
Contributor Author

grgia commented Sep 14, 2023

@thesahindia sorry for the ping, forgot we changed the logic to assign C+ before engineers.

I need to have this PR merged today @allroundexperts , let me know if I should have it reviewed internally

@grgia grgia removed the request for review from thesahindia September 14, 2023 10:09
@allroundexperts
Copy link
Contributor

Will finish the review today @grgia!

Copy link
Contributor

@allroundexperts allroundexperts left a comment

Choose a reason for hiding this comment

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

Testing well!

@melvin-bot melvin-bot bot requested a review from Li357 September 14, 2023 13:14
@melvin-bot
Copy link

melvin-bot bot commented Sep 14, 2023

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

@Li357
Copy link
Contributor

Li357 commented Sep 14, 2023

Looks good! All set to merge @grgia?

@grgia grgia merged commit cd9e86e into main Sep 15, 2023
@grgia grgia deleted the georgia-addLightTheme branch September 15, 2023 01:12
@grgia
Copy link
Contributor Author

grgia commented Sep 15, 2023

@allroundexperts thank you again! I appreciate your speedy C+ review here 🙏

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

successHover: colors.greenHover,
successPressed: colors.greenPressed,
transparent: colors.transparent,
midtone: colors.green700,
Copy link
Contributor

Choose a reason for hiding this comment

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

hey @grgia, midtone is being using in RequestMoney and Status page, remove it will lead to crash
https://expensify.slack.com/archives/C049HHMV9SM/p1694744871014989

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/grgia in version: 1.3.71-0 🚀

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

@kavimuru
Copy link

@grgia What do we check in mweb, desktop and iOS?

image

@kavimuru
Copy link

@allroundexperts @Li357 Could you help us with what to validate in mweb, desktop and iOS?

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.71-12 🚀

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

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

Projects

No open projects
Status: Done - Live

Development

Successfully merging this pull request may close these issues.

8 participants