Empty State Component for Search by filip-solecki · Pull Request #44137 · Expensify/App

filip-solecki · 2024-06-21T09:33:56Z

Details

We want to make empty states feel nicer by using a subtle hint that the page will eventually contain data by using a faded row pattern, while also creating space for the middle of the page to show an informative or educational modal.

Fixed Issues

$ #43747
PROPOSAL: N/A

Tests

Log in to the app
Go to Search page from LHP
Go to Workspaces
Enable Tags and open Tags page
Open Categories page and remove all categories

Verify that no errors appear in the JS console

Offline tests

QA Steps

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

… category pages

kosmydel

LGTM, I've left some minor comments 🚀

kosmydel · 2024-06-25T11:54:32Z

src/components/EmptyStateComponent/index.tsx

+import CONST from '@src/CONST';
+import type {EmptyStateComponentProps, VideoLoadedEventType} from './types';
+
+const VIDEO_ASPECT_RATIO = 400 / 225;


I'm not sure, but shouldn't it be included in CONSTs?

Will the aspect ratio always be the same?

It may be different for each usage. Here it is adjusted to the "Modal" size

It would be great to leave a comment about this, how did we get to this ratio?

src/components/EmptyStateComponent/index.tsx

src/pages/Search/EmptySearchView.tsx

src/styles/index.ts

melvin-bot · 2024-06-25T13:07:37Z

@shawnborton @eVoloshchak 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 · 2024-06-25T14:41:09Z

Can you vertically and horizontally center the illustration here?

shawnborton · 2024-06-25T14:45:33Z

How much padding are you using on this part of the component? Feels like there is a bit too much padding at the bottom:

shawnborton · 2024-06-25T14:46:46Z

Can we check the padding of the search skeleton rows in the BG? Seems like there is too much left padding there compared to vertical padding above/below the receipt thumbnail:

shawnborton · 2024-06-25T15:14:55Z

It looks like the right side of the search skeleton rows has a harsh cut off too:

shawnborton · 2024-07-10T08:49:03Z

Lovely! Okay, l think we should get this thing into final review then?

filip-solecki · 2024-07-10T08:54:14Z

Awesome, I see @eVoloshchak didn't finish the checklist

eVoloshchak

LGTM!

mountiny

Thank you! Small comments

mountiny · 2024-07-10T13:35:04Z

src/components/EmptyStateComponent/index.tsx

+import CONST from '@src/CONST';
+import type {EmptyStateComponentProps, VideoLoadedEventType} from './types';
+
+const VIDEO_ASPECT_RATIO = 400 / 225;


It would be great to leave a comment about this, how did we get to this ratio?

src/components/Skeletons/SearchRowSkeleton.tsx

mountiny

Thank you

OSBotify · 2024-07-10T15:08:53Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

shawnborton · 2024-07-15T20:32:44Z

So this is looking awesome @filip-solecki but I found one little bug here - it seems like the layout slightly shifts when the empty state loads right after the loading skeleton:

CleanShot.2024-07-15.at.22.30.39.mp4

Seems like we might just need some more horizontal padding around the loading skeleton? The whole view should be wrapped with 20px horizontal padding, but it looks like there is a difference between the two. Do you mind creating a follow up PR when you get a moment? Thanks!

OSBotify · 2024-07-15T21:04:08Z

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.7-3 🚀

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

OSBotify · 2024-07-15T22:12:52Z

🚀 Cherry-picked to staging by https://github.com/thienlnam in version: 9.0.7-4 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

shawnborton · 2024-07-16T05:29:49Z

Also looks like we missed a spot in the workspace editor for this new style too:

filip-solecki · 2024-07-16T06:02:29Z

Sure, I'll prepare follow-up PR probably today

shawnborton · 2024-07-16T06:05:26Z

Perfect, thanks Filip!

OSBotify · 2024-07-17T00:18:25Z

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.7-8 🚀

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

OSBotify · 2024-07-18T13:49:26Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.8-6 🚀

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

shawnborton · 2024-08-07T11:34:28Z

Friendly bump on those follow up items @filip-solecki

filip-solecki · 2024-08-07T11:39:05Z

Only this comment left right?

shawnborton · 2024-08-07T11:41:58Z

I think so. We implemented this for report fields, right?

filip-solecki · 2024-08-07T11:42:56Z

Yes, here

shawnborton · 2024-08-07T11:46:12Z

Cool, thanks for confirming!

Ollyws · 2025-03-10T10:40:49Z

src/components/EmptyStateComponent/index.tsx

+
+    return (
+        <ScrollView contentContainerStyle={styles.emptyStateScrollView}>
+            <View style={styles.skeletonBackground}>


Having this view inside the scrollview was causing the skeleton to become scrollable at a certain page height, we fixed this in #57232

filip-solecki added 15 commits June 20, 2024 10:48

Empty State Component for Search

f0ba486

Remove backgroundColor

a995861

Animation case

9f3a62c

Add animation and implement on Search page

01333bc

Merge branch 'main' into filip-solecki/empty-state-component

d1ad016

Small fixes on search empty page, add new empty component on tags and…

9c09664

… category pages

Small fixes

87c69fa

remove unnecessary expensicon

a19228a

Adjust to final design

094a373

Fix video styling

31f04c7

remove unnecessary styles

77fc807

self review fixes

0b8b124

Add height for illustrations

a4bbb64

Fix lint

ed66059

Use RN StyleSheet flatten function

2676725

kosmydel approved these changes Jun 25, 2024

View reviewed changes

cr fixes

774345b

filip-solecki marked this pull request as ready for review June 25, 2024 13:07

filip-solecki requested review from a team as code owners June 25, 2024 13:07

melvin-bot bot requested review from eVoloshchak and shawnborton and removed request for a team June 25, 2024 13:07

shawnborton added the Ready To Build label Jun 25, 2024

This comment has been minimized.

Sign in to view

eVoloshchak approved these changes Jul 10, 2024

View reviewed changes

melvin-bot bot requested a review from mountiny July 10, 2024 13:03

mountiny previously approved these changes Jul 10, 2024

View reviewed changes

Use variables for LHP width calculations

544bb4c

filip-solecki dismissed mountiny’s stale review via 544bb4c July 10, 2024 13:45

mountiny approved these changes Jul 10, 2024

View reviewed changes

mountiny merged commit 8978256 into Expensify:main Jul 10, 2024

github-actions bot mentioned this pull request Jul 15, 2024

Deploy Checklist: New Expensify 2024-07-15 #45421

Closed

melvin-bot bot mentioned this pull request Jul 17, 2024

[HOLD for payment 2024-08-14] [HOLD for payment 2024-07-24] [$250] Create empty state component for list view pages #43747

Closed

filip-solecki mentioned this pull request Jul 30, 2024

Add new empty state component to report fields page #46476

Merged

50 tasks

shawnborton mentioned this pull request Aug 7, 2024

[PAY AUG 22ND][$250] Search-Skeleton during loading & in empty state are aligned differently compared to production #46949

Closed

6 tasks

Krishna2323 mentioned this pull request Aug 27, 2024

[$250] Empty state list view does not use 400px as the width of the inner "modal" area #47967

Closed

6 tasks

bernhardoj mentioned this pull request Dec 11, 2024

[Due for payment 2025-03-10] [$250] Workspace - Unable to scroll the page &skeleton pattern differs #53917

Closed

8 tasks

Ollyws reviewed Mar 10, 2025

View reviewed changes

Conversation

filip-solecki commented Jun 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

kosmydel left a comment

Choose a reason for hiding this comment

Uh oh!

kosmydel Jun 25, 2024

Choose a reason for hiding this comment

Uh oh!

filip-solecki Jun 25, 2024

Choose a reason for hiding this comment

Uh oh!

mountiny Jul 10, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

melvin-bot bot commented Jun 25, 2024

Uh oh!

shawnborton commented Jun 25, 2024

Uh oh!

shawnborton commented Jun 25, 2024

Uh oh!

shawnborton commented Jun 25, 2024

Uh oh!

This comment has been minimized.

shawnborton commented Jun 25, 2024

Uh oh!

shawnborton commented Jul 10, 2024

Uh oh!

filip-solecki commented Jul 10, 2024

Uh oh!

eVoloshchak left a comment

Choose a reason for hiding this comment

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

mountiny Jul 10, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Jul 10, 2024

Uh oh!

shawnborton commented Jul 15, 2024

Uh oh!

OSBotify commented Jul 15, 2024

Uh oh!

OSBotify commented Jul 15, 2024

Uh oh!

shawnborton commented Jul 16, 2024

Uh oh!

filip-solecki commented Jul 16, 2024

Uh oh!

shawnborton commented Jul 16, 2024

Uh oh!

OSBotify commented Jul 17, 2024

Uh oh!

OSBotify commented Jul 18, 2024

Uh oh!

shawnborton commented Aug 7, 2024

Uh oh!

filip-solecki commented Aug 7, 2024

Uh oh!

shawnborton commented Aug 7, 2024

Uh oh!

filip-solecki commented Aug 7, 2024

filip-solecki commented Jun 21, 2024 •

edited

Loading