Feature: Empty state UI for LHN by tienifr · Pull Request #37361 · Expensify/App

tienifr · 2024-02-27T22:33:03Z

Details

This PR implements an "empty state" UI when users have cleared out the LHN in #focus mode on small screen devices.

Fixed Issues

$ #34926
PROPOSAL: #34926 (comment)

Tests

Small screen devices only

Switch to #focus mode
Mark all reports as read or unpin them so that LHN is cleared out
Verify the empty state UI shows as expected
Verify it in different themes, languages and devices

Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

Small screen devices only

Switch to #focus mode
Mark all reports as read or unpin them so that LHN is cleared out
Verify the empty state UI shows as expected

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Native

Screen.Recording.2024-03-04.at.22.06.56-compressed.mov

Screen.Recording.2024-03-04.at.22.06.28-compressed.mov

mWeb

Screen.Recording.2024-03-04.at.22.07.43-compressed.mov

Screen.Recording.2024-03-04.at.22.07.22-compressed.mov

Screen.Recording.2024-03-04.at.22.05.59-compressed.mov

…pty-state-ui-lhn

melvin-bot · 2024-02-28T20:22:52Z

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

tienifr · 2024-02-29T08:26:28Z

@DylanDylann The logic of adding Concierge chat here is supposed to remove but I need testing it carefully. For now, please hard code that.

DylanDylann · 2024-02-29T08:29:01Z

@tienifr Yeah, ping me again when all logic is ready

tienifr · 2024-02-29T09:30:19Z

        update: 'Actualizar',
        member: 'Miembro',
        role: 'Role',
+        emptyLHN: {


Copy was verified here.

…pty-state-ui-lhn

tienifr · 2024-03-04T15:16:59Z

@DylanDylann The changes are ready for review. I tested removing the logic to add Concierge chat when report list is empty and verified it did not cause any trouble.

@roryabraham Also please add Design label so design team can weigh in.

roryabraham · 2024-03-06T00:21:28Z

design label didn't work so I'm manually requesting review from @dannymcclain, who created the mockups

DylanDylann · 2024-03-06T07:58:02Z

@tienifr Jest Unit Tests / Storybook tests (pull_request) is failed

…pty-state-ui-lhn

tienifr · 2024-03-27T16:09:11Z

I'm working on the storybook test failure. Will post update tomorrow.

tienifr · 2024-03-28T21:01:57Z

I've resolved all @roryabraham feedback above and fixed Storybook test failure. @DylanDylann This is ready for your review & retest again.

tienifr · 2024-03-28T21:05:14Z


+        // We can ignore the "module not installed" warning from lottie-react-native
+        // because we are not using the library for JSON format of Lottie animations.
+        config.ignoreWarnings = [{module: new RegExp('node_modules/lottie-react-native/lib/module/LottieView/index.web.js')}];


This was referenced from:

App/config/webpack/webpack.common.js

Lines 61 to 65 in 59a71f3

stats: {

// We can ignore the "module not installed" warning from lottie-react-native

// because we are not using the library for JSON format of Lottie animations.

warningsFilter: ['./node_modules/lottie-react-native/lib/module/LottieView/index.web.js'],

},

I already tried that stats.warningsFilter config and used the correct module path but it didn't work. I'm not sure about that. However, based on the recommendation here, ignoreWarnings seems a better alternative.

@tienifr If we don't add this change, which story test will be failed

There're no specific test fail, it just threw an error/warning when we built the story page. More info here (Please expand the Storybook run section and scroll to bottom).

Oh yeah, It helps remove some warnings but I still see errors in Story Test. But it seems it isn't related to this PR.

DylanDylann · 2024-04-01T03:37:10Z

+    shouldEmbedLinkWithSubtitle?: boolean;
+
+    /** Render custom subtitle */
+    CustomSubtitle?: React.ReactElement;


@tienifr Using camelCase convention

We used PascalCase for component props like here, here, here and here.

PascalCase is correct for component props

DylanDylann · 2024-04-01T03:50:43Z

App/src/components/LHNOptionsList/OptionRowLHN.tsx

Lines 50 to 52 in b282693

    
           if (!optionItem) { 
        
               return null; 
        
           }

Should we remove this code or move it out of OptionRowLHN to ensure all logic to hide reports in LHN is moved to LHNOptionsList?

DylanDylann · 2024-04-01T04:10:31Z

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 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 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(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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Screen.Recording.2024-04-01.at.11.43.17.mov

Android: mWeb Chrome

Screen.Recording.2024-04-01.at.11.40.23.mov

iOS: Native

Screen.Recording.2024-04-01.at.11.46.35.mov

iOS: mWeb Safari

Screen.Recording.2024-04-01.at.11.43.57.mov

MacOS: Chrome / Safari

MacOS: Desktop

DylanDylann

@roryabraham Could you help to re-run all tests?

…pty-state-ui-lhn

DylanDylann · 2024-04-01T10:23:26Z

@roryabraham I approved this PR to re-run all tests. A minor comment. Everything else looks good

melvin-bot · 2024-04-01T19:24:50Z

@roryabraham looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

OSBotify · 2024-04-01T19:31:23Z

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

roryabraham · 2024-04-01T19:31:47Z

not an emergency, we're working on fixing this: https://expensify.slack.com/archives/C07J32337/p1711999860875239?thread_ts=1711998323.452789&cid=C07J32337

OSBotify · 2024-04-02T11:14:06Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.4.59-0 🚀

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

OSBotify · 2024-04-08T10:54:11Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.60-13 🚀

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

parasharrajat · 2024-06-19T07:21:09Z

        onFirstItemRendered();
    }, [onFirstItemRendered]);

+    const emptyLHNSubtitle = useMemo(


UI was broken on Android devices. Let's make sure we test this so that the UI looks good on each platform. #41349

allroundexperts · 2025-02-25T17:00:26Z

We missed a case for wide screen which caused #54569 later on.

tienifr added 6 commits February 28, 2024 05:28

feature: empty state ui for lhn

cc3916e

middle align UI

ec0cc27

fix nested teneray operation

0dbec9e

Merge branch 'main' of https://github.com/tienifr/App into feature/em…

932231b

…pty-state-ui-lhn

remove storybook warning

d824c5a

Merge branch 'main' of https://github.com/tienifr/App into feature/em…

5cd1b27

…pty-state-ui-lhn

tienifr marked this pull request as ready for review February 28, 2024 20:22

tienifr requested a review from a team as a code owner February 28, 2024 20:22

melvin-bot Bot requested review from DylanDylann and removed request for a team February 28, 2024 20:22

tienifr mentioned this pull request Feb 28, 2024

[HOLD for payment 2024-04-15] [$500] HIGH: Add empty state UI for the LHN #34926

Closed

tienifr commented Feb 29, 2024

View reviewed changes

tienifr added 2 commits March 4, 2024 16:40

Merge branch 'main' of https://github.com/tienifr/App into feature/em…

685ae15

…pty-state-ui-lhn

middle align the ui

2197773

roryabraham added Design Ready To Build labels Mar 6, 2024

Expensify deleted a comment from github-actions Bot Mar 6, 2024

roryabraham requested review from dannymcclain and roryabraham March 6, 2024 00:20

This comment has been minimized.

Sign in to view

DylanDylann reviewed Mar 6, 2024

View reviewed changes

Comment thread src/components/LHNOptionsList/LHNOptionsList.tsx Outdated

Comment thread src/components/LHNOptionsList/LHNOptionsList.tsx Outdated

Comment thread src/styles/variables.ts

Comment thread src/components/LHNOptionsList/LHNOptionsList.tsx Outdated

DylanDylann reviewed Mar 6, 2024

View reviewed changes

Comment thread src/components/BlockingViews/BlockingView.tsx Outdated

Comment thread src/components/BlockingViews/BlockingView.tsx Outdated

Merge branch 'main' of https://github.com/tienifr/App into feature/em…

821278a

…pty-state-ui-lhn

DylanDylann reviewed Mar 6, 2024

View reviewed changes

Comment thread .storybook/webpack.config.js Outdated

roryabraham requested changes Mar 27, 2024

View reviewed changes

Comment thread src/components/BlockingViews/BlockingView.tsx Outdated

Comment thread src/components/BlockingViews/BlockingView.tsx Outdated

type inference

030593a

tienifr dismissed dannymcclain’s stale review via 030593a March 28, 2024 04:31

tienifr added 2 commits March 29, 2024 02:36

Add conditional required type for BlockingView

a50a27e

Fix storybook test

7e3e4f9

tienifr commented Mar 28, 2024

View reviewed changes

Merge branch 'main' into feature/empty-state-ui-lhn

9c203d2

DylanDylann reviewed Apr 1, 2024

View reviewed changes

DylanDylann approved these changes Apr 1, 2024

View reviewed changes

melvin-bot Bot requested a review from roryabraham April 1, 2024 04:47

Merge branch 'main' of https://github.com/tienifr/App into feature/em…

2170e9d

…pty-state-ui-lhn

roryabraham approved these changes Apr 1, 2024

View reviewed changes

roryabraham merged commit 732555a into Expensify:main Apr 1, 2024

melvin-bot Bot added the Emergency label Apr 1, 2024

roryabraham removed the Emergency label Apr 1, 2024

github-actions Bot mentioned this pull request Apr 2, 2024

Deploy Checklist: New Expensify 2024-04-02 #39399

Closed

87 tasks

parasharrajat reviewed Jun 19, 2024

View reviewed changes

parasharrajat mentioned this pull request Jun 19, 2024

[HOLD for payment 2024-06-28] [$500] Android - LHN - Magic glass icon overlaps text #41349

Closed

truph01 mentioned this pull request Dec 25, 2024

[Due for payment 2025-02-18] [$250] Web - LHN - LHN shows empty without any placeholder #54569

Closed

8 tasks

	stats: {
	// We can ignore the "module not installed" warning from lottie-react-native
	// because we are not using the library for JSON format of Lottie animations.
	warningsFilter: ['./node_modules/lottie-react-native/lib/module/LottieView/index.web.js'],
	},

Uh oh!

Conversation

tienifr commented Feb 27, 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!

melvin-bot Bot commented Feb 28, 2024

Uh oh!

tienifr commented Feb 29, 2024

Uh oh!

DylanDylann commented Feb 29, 2024

Uh oh!

tienifr Feb 29, 2024

Choose a reason for hiding this comment

Uh oh!

tienifr commented Mar 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

roryabraham commented Mar 6, 2024

Uh oh!

This comment has been minimized.

DylanDylann commented Mar 6, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tienifr commented Mar 27, 2024

Uh oh!

Uh oh!

Uh oh!

tienifr commented Mar 28, 2024

Uh oh!

tienifr Mar 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DylanDylann Apr 1, 2024

Choose a reason for hiding this comment

Uh oh!

tienifr Apr 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DylanDylann Apr 1, 2024

Choose a reason for hiding this comment

Uh oh!

DylanDylann Apr 1, 2024

Choose a reason for hiding this comment

Uh oh!

tienifr Apr 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

roryabraham Apr 1, 2024

Choose a reason for hiding this comment

Uh oh!

DylanDylann commented Apr 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DylanDylann commented Apr 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

DylanDylann left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DylanDylann commented Apr 1, 2024

Uh oh!

tienifr commented Feb 27, 2024 •

edited

Loading

tienifr commented Mar 4, 2024 •

edited

Loading

tienifr Mar 28, 2024 •

edited

Loading

tienifr Apr 1, 2024 •

edited

Loading

tienifr Apr 1, 2024 •

edited

Loading

DylanDylann commented Apr 1, 2024 •

edited

Loading

DylanDylann commented Apr 1, 2024 •

edited

Loading

DylanDylann left a comment •

edited

Loading