Feature: Implement theme dependent illustrations (`useThemeIllustrations` hook) #31452

chrispader · 2023-11-16T16:27:27Z

Details

Adds a new useThemeIllustrations hook which uses the dynamic theme illustrations from the ThemeIllustrationsProvider.

This PR also updates all components in the app that use illustrations

Fixed Issues

$ #21017
PROPOSAL:

Tests

Place the following code snippet into the render function of src/Expensify.js before any early return:

useEffect(() => {
    Onyx.set(ONYXKEYS.PREFERRED_THEME, 'light') // Adapt to "dark" if needed
}, [])

Go to a new report/chat
Check if the placeholder image for empty chats is displayed correctly for the light and dark theme

Verify that no errors appear in the JS console

Offline tests

Same as in Tests.

QA Steps

No QA.

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(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 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 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

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

Only added screenshots for macOS web (Safari) for showcase of test steps...

melvin-bot · 2023-11-16T16:27:33Z

@dannymcclain @shubham1206agra 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]

shubham1206agra · 2023-11-16T16:33:07Z

@chrispader @grgia Is my review required here?

grgia · 2023-11-16T17:12:00Z

src/styles/illustrations/light.ts

+import EmptyStateBackgroundImage from '@assets/images/empty-state_background-fade-light.png';
+import Abracadabra from '@assets/images/product-illustrations/abracadabra.svg';
+import BankArrowPink from '@assets/images/product-illustrations/bank-arrow--pink.svg';
+import BankMouseGreen from '@assets/images/product-illustrations/bank-mouse--green.svg';
+import BankUserGreen from '@assets/images/product-illustrations/bank-user--green.svg';
+import ConciergeBlue from '@assets/images/product-illustrations/concierge--blue.svg';
+import ConciergeExclamation from '@assets/images/product-illustrations/concierge--exclamation.svg';


@chrispader rather than importing all these images, what if we only used the provider for the theme specific ones and left the rest using the old pattern?

yea sure, wasn't sure if all illustrations are theme-dependent.

once we have a list of all theme-dependent illustrations, i can simply adapt the affected components

i'd still move the files with the imports to src/styles/illustrations. wdyt?

Right now it is looking like it's only the background image, though the list might grow when we do a final QA of the theme. Hb we assume it's only that one for now?

I'll leave the hook and context as is then and just update the list of imports. I can keep the branch with all of these changes, in case there are more dynamic illustrations coming soon

@grgia updated the PR accordingly :)

dannymcclain · 2023-11-16T18:46:54Z

@grgia I honestly don't know what value I can provide as a reviewer here?

grgia · 2023-11-17T13:08:20Z

all good @dannymcclain removed you as a reviewer!

grgia

Code LGTM,

Let's add test steps to manually change the theme to light mode and check that the background image is correct :)

And then NO QA for QA section

chrispader · 2023-11-17T15:37:19Z

Code LGTM,

Let's add test steps to manually change the theme to light mode and check that the background image is correct :)

And then NO QA for QA section

done @grgia

grgia · 2023-11-20T10:22:57Z

@chrispader could you add screenshots that show that the background image is correct for both light and dark?

chrispader · 2023-11-20T13:16:19Z

@chrispader could you add screenshots that show that the background image is correct for both light and dark?

may bad, sorry uploaded the wrong screenshot.. added screenshots with the dynamic illustration! @grgia

grgia

LGTM!!

grgia · 2023-11-22T10:33:09Z

@shubham1206agra would you be interested in checklist/screenshots to ensure this image loads on dark/light mode on all platforms?

shubham1206agra · 2023-11-22T10:34:20Z

Yes I will do it

shubham1206agra · 2023-11-22T11:37:59Z

@grgia Do I need check these too?

grgia · 2023-11-22T13:21:43Z

@shubham1206agra which are you referring to?

shubham1206agra · 2023-11-22T13:45:06Z

Themes not applied to images shown above

grgia · 2023-11-22T13:45:40Z

@shubham1206agra the only image that is effected is the background image!

shubham1206agra · 2023-11-22T13:46:29Z

Ok then I will ignore these.

shubham1206agra · 2023-11-24T06:11:42Z

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(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 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 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

chrispader · 2023-11-27T15:43:39Z

can we merge this @grgia ? :)

chrispader · 2023-11-27T15:45:59Z

🎉🎉

OSBotify · 2023-11-27T15:48:47Z

✋ 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 · 2023-11-27T19:23:13Z

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

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

OSBotify · 2023-11-29T11:45:49Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.4-3 🚀

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

chrispader added 5 commits November 16, 2023 17:05

fix: remove TODO comment

6975d2f

feat: add useThemeIllustrations hook and context

80afdf3

fix: migrate all files that use illustrations

a043751

move file

69affbd

add ThemeIllustrationsProvider

9cfaabd

chrispader requested a review from a team as a code owner November 16, 2023 16:27

melvin-bot bot requested review from dannymcclain and shubham1206agra and removed request for a team November 16, 2023 16:27

fix: remaining uses

fa16347

chrispader mentioned this pull request Nov 16, 2023

[HOLD for payment 2023-12-06] Add Light Theme Illustrations to App and create Hook for Illustrations #21017

Closed

chrispader added 3 commits November 16, 2023 17:35

add empty state background

5a5be5e

fix: imports

0c364d9

fix: import

1b435eb

grgia self-requested a review November 16, 2023 17:08

grgia reviewed Nov 16, 2023

View reviewed changes

grgia removed the request for review from dannymcclain November 17, 2023 13:08

Christoph Pader added 2 commits November 17, 2023 14:14

fix: only use hook for empty state background

2b2d7b9

Merge branch 'main' into @chrispader/use-theme-illustrations

d18c578

grgia reviewed Nov 17, 2023

View reviewed changes

Merge branch 'main' into @chrispader/use-theme-illustrations

1aeec98

Merge branch 'main' into @chrispader/use-theme-illustrations

eab61d4

feat: add types for theme illustrations

8330198

grgia approved these changes Nov 20, 2023

View reviewed changes

shubham1206agra approved these changes Nov 24, 2023

View reviewed changes

melvin-bot bot requested a review from grgia November 24, 2023 06:13

grgia approved these changes Nov 27, 2023

View reviewed changes

grgia merged commit 0a05917 into Expensify:main Nov 27, 2023
16 of 17 checks passed

github-actions bot mentioned this pull request Nov 27, 2023

Deploy Checklist: New Expensify 2023-11-27 #32066

Closed

53 tasks

tienifr mentioned this pull request Dec 5, 2023

[$500] Chat - No gradient between the solid color and the image in the background #32441

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: Implement theme dependent illustrations (`useThemeIllustrations` hook) #31452

Feature: Implement theme dependent illustrations (`useThemeIllustrations` hook) #31452

chrispader commented Nov 16, 2023 •

edited

Loading

melvin-bot bot commented Nov 16, 2023

shubham1206agra commented Nov 16, 2023

grgia Nov 16, 2023

chrispader Nov 16, 2023

chrispader Nov 16, 2023

grgia Nov 17, 2023

chrispader Nov 17, 2023

chrispader Nov 17, 2023

dannymcclain commented Nov 16, 2023

grgia commented Nov 17, 2023

grgia left a comment

chrispader commented Nov 17, 2023

grgia commented Nov 20, 2023

chrispader commented Nov 20, 2023

grgia left a comment

grgia commented Nov 22, 2023

shubham1206agra commented Nov 22, 2023

shubham1206agra commented Nov 22, 2023

grgia commented Nov 22, 2023

shubham1206agra commented Nov 22, 2023

grgia commented Nov 22, 2023

shubham1206agra commented Nov 22, 2023

shubham1206agra commented Nov 24, 2023

chrispader commented Nov 27, 2023

chrispader commented Nov 27, 2023

OSBotify commented Nov 27, 2023

OSBotify commented Nov 27, 2023

OSBotify commented Nov 29, 2023

Feature: Implement theme dependent illustrations (useThemeIllustrations hook) #31452

Feature: Implement theme dependent illustrations (useThemeIllustrations hook) #31452

Conversation

chrispader commented Nov 16, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 16, 2023

shubham1206agra commented Nov 16, 2023

grgia Nov 16, 2023

Choose a reason for hiding this comment

chrispader Nov 16, 2023

Choose a reason for hiding this comment

chrispader Nov 16, 2023

Choose a reason for hiding this comment

grgia Nov 17, 2023

Choose a reason for hiding this comment

chrispader Nov 17, 2023

Choose a reason for hiding this comment

chrispader Nov 17, 2023

Choose a reason for hiding this comment

dannymcclain commented Nov 16, 2023

grgia commented Nov 17, 2023

grgia left a comment

Choose a reason for hiding this comment

chrispader commented Nov 17, 2023

grgia commented Nov 20, 2023

chrispader commented Nov 20, 2023

grgia left a comment

Choose a reason for hiding this comment

grgia commented Nov 22, 2023

shubham1206agra commented Nov 22, 2023

shubham1206agra commented Nov 22, 2023

grgia commented Nov 22, 2023

shubham1206agra commented Nov 22, 2023

grgia commented Nov 22, 2023

shubham1206agra commented Nov 22, 2023

shubham1206agra commented Nov 24, 2023

Reviewer Checklist

Screenshots/Videos

chrispader commented Nov 27, 2023

chrispader commented Nov 27, 2023

OSBotify commented Nov 27, 2023

OSBotify commented Nov 27, 2023

OSBotify commented Nov 29, 2023

Feature: Implement theme dependent illustrations (`useThemeIllustrations` hook) #31452

Feature: Implement theme dependent illustrations (`useThemeIllustrations` hook) #31452

chrispader commented Nov 16, 2023 •

edited

Loading