Ideal nav LHP #32473

WojtekBoman · 2023-12-05T12:13:18Z

Details

This PR introduces the Left Hand Pane to the app. It's implemented analogously to the Right Hand Pane.
The most important changes:

Search screen has been moved to the LHP
Added the configuration for the LHP based on the RHP configuration with some adjustments (LHP animation is reverted)
linkTo function has been updated to handle dismissing LHP
Referral has been removed from the SearchPage

Fixed Issues

$ #32939
PROPOSAL: described in the design doc here: https://docs.google.com/document/d/1VnEf2ThbbiQj0kx9KnAihF0DWf50s2Bn_MztEyEwtjg/edit#heading=h.r39uu4rszpv

Tests

Log in to the app.
Press on the search icon at the top of the sidebar.
Check if the search screen is opened on the left side of the screen.

Verify that no errors appear in the JS console

Offline tests

Log in to the app.
Press on the search icon at the top of the sidebar.
Check if the search screen is opened on the left side of the screen.

QA Steps

Log in to the app.
Press on the search icon at the top of the sidebar.
Check if the search screen is opened on the left side of the screen.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2023-12-14.at.14.24.02.mov

Android: mWeb Chrome

Screen.Recording.2023-12-14.at.14.29.23.mov

iOS: Native

Screen.Recording.2023-12-14.at.13.53.11.mov

iOS: mWeb Safari

Screen.Recording.2023-12-14.at.14.26.13.mov

MacOS: Chrome / Safari

Screen.Recording.2023-12-14.at.14.05.21.mov

MacOS: Desktop

Screen.Recording.2023-12-14.at.14.03.46.mov

melvin-bot · 2023-12-14T13:48:08Z

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

mountiny · 2023-12-15T09:36:52Z

@hayata-suenaga correct this should not be influencing the current code so it can go to main

WojtekBoman · 2023-12-15T09:54:21Z

NAB: CustomRouter contains logic to extract the report id from the RHP screen params to show the correct report in the central panel. We should probably do the same for the LHP.

You're right but currently we don't store any page connected with specific report in the LHP, so there is no reportID to extract

mountiny · 2023-12-15T15:16:30Z

@WojtekBoman The overlay seems to be weirdly animating here

WojtekBoman · 2023-12-15T15:59:54Z

@WojtekBoman The overlay seems to be weirdly animating here

@mountiny Thank you for noticing this. I've added the fix and now the animation should work fine

Screen.Recording.2023-12-15.at.16.58.09.mov

s77rt · 2023-12-15T16:55:03Z

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

Android: mWeb Chrome

mweb-chrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

mweb-safari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

src/libs/Navigation/AppNavigator/Navigators/Overlay.tsx

src/libs/Navigation/AppNavigator/getRootNavigatorScreenOptions.ts

mountiny

Thank you, changes look good to me and I have only noticed one issue that when thr page is narrower than 920px roughly the overlay effect is still a bit odd. I think thats not a blocker though

OSBotify · 2023-12-18T10:48:15Z

✋ 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-12-19T02:43:18Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.14-0 🚀

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

OSBotify · 2023-12-19T03:46:39Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.14-0 🚀

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

OSBotify · 2023-12-21T05:14:14Z

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

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

…v-lhp" This reverts commit 648c000, reversing changes made to f017c6b.

Revert "Merge pull request #32473 from software-mansion-labs/ideal-na…

Revert "Merge pull request #32473 from software-mansion-labs/ideal-na… (cherry picked from commit 5b91c04)

OSBotify · 2023-12-26T00:14:28Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.16-5 🚀

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

WojtekBoman and others added 22 commits December 4, 2023 15:17

Add LeftModalNavigator

379ac08

Add LHP Animation, dismissing modals, borderRadius

3af4938

Modify linkTo function

b2130bb

Add types for LHP screens, move dismissModal to separated file

bdb17ef

Remove dismissModal from Navigation.ts

e0cc1c7

Refactor linkTo method

a0806cb

Refactor dismissModal function

33108e3

fix: 30062

456eff6

add dependency

ca645b6

add name value

6a315f6

fix lint

f32a907

update name to null when offline

e180b99

spread the array

9677a22

Add TS to LHP

152c136

Refactor LHP linking config

0c7d7b8

Rename RHPScreenOptions to ModalNavigatorScreenOptions

4b875bb

Fix import order in LHP and RHP

7694af7

Merge branch 'main' into ideal-nav-lhp

062f969

Merge branch 'main' into ideal-nav-lhp

4ccba51

Refactor LHPNavigatorContainer borderRadius

6f5fab2

Remove referral from SearchPage

7753b91

Remove borderRadius from the LHP on small screens

3bbad0e

WojtekBoman marked this pull request as ready for review December 14, 2023 13:48

WojtekBoman requested a review from a team as a code owner December 14, 2023 13:48

melvin-bot bot requested review from sobitneupane and removed request for a team December 14, 2023 13:48

mountiny changed the title ~~Ideal nav LHP~~ [NoQA] Ideal nav LHP Dec 14, 2023

mountiny changed the title ~~[NoQA] Ideal nav LHP~~ Ideal nav LHP Dec 14, 2023

mountiny removed the request for review from sobitneupane December 14, 2023 15:07

Merge branch 'main' into ideal-nav-lhp

fb9e622

Fix overlay animationfor LHP

4d45639

Refactor goBack function to handle LHP

02953bf

s77rt approved these changes Dec 15, 2023

View reviewed changes

hayata-suenaga reviewed Dec 15, 2023

View reviewed changes

src/libs/Navigation/AppNavigator/Navigators/Overlay.tsx Show resolved Hide resolved

hayata-suenaga reviewed Dec 15, 2023

View reviewed changes

src/libs/Navigation/AppNavigator/getRootNavigatorScreenOptions.ts Show resolved Hide resolved

Update leftModalNavigator comment

b54996f

mountiny approved these changes Dec 18, 2023

View reviewed changes

mountiny merged commit 648c000 into Expensify:main Dec 18, 2023
16 checks passed

WojtekBoman mentioned this pull request Dec 18, 2023

Fix LHP animation on smaller screens #33218

Merged

47 tasks

github-actions bot mentioned this pull request Dec 19, 2023

Deploy Checklist: New Expensify 2023-12-19 #33264

Closed

98 tasks

mkhutornyi mentioned this pull request Dec 20, 2023

[HOLD for payment 2023-12-29] [HOLD for payment 2023-12-28] Sign up - App crashes when signing up with a new account via magic link #33354

Closed

6 tasks

melvin-bot bot mentioned this pull request Dec 21, 2023

[HOLD for payment 2024-01-02] [HOLD for payment 2023-12-28] [$500] Implement Left Hand Nav #32939

Closed

mountiny added a commit that referenced this pull request Dec 21, 2023

Revert "Merge pull request #32473 from software-mansion-labs/ideal-na…

ad634d1

…v-lhp" This reverts commit 648c000, reversing changes made to f017c6b.

mountiny mentioned this pull request Dec 21, 2023

Revert "Merge pull request #32473 from software-mansion-labs/ideal-na… #33406

Merged

50 tasks

Beamanator added a commit that referenced this pull request Dec 21, 2023

Merge pull request #33406 from Expensify/vit-revert32473

5b91c04

Revert "Merge pull request #32473 from software-mansion-labs/ideal-na…

OSBotify pushed a commit that referenced this pull request Dec 21, 2023

Merge pull request #33406 from Expensify/vit-revert32473

ad5baeb

Revert "Merge pull request #32473 from software-mansion-labs/ideal-na… (cherry picked from commit 5b91c04)

github-actions bot mentioned this pull request Dec 22, 2023

Deploy Checklist: New Expensify 2023-12-22 #33480

Closed

32 tasks

lanitochka17 mentioned this pull request Dec 22, 2023

[$500] Web/mWeb - Search - Search screen is in RHP instead of LHP #33511

Closed

6 tasks

s77rt mentioned this pull request Dec 23, 2023

[wave8] Ideal Nav Left Hand Panel Search #33499

Merged

48 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ideal nav LHP #32473

Ideal nav LHP #32473

WojtekBoman commented Dec 5, 2023 •

edited

Loading

melvin-bot bot commented Dec 14, 2023

mountiny commented Dec 15, 2023

WojtekBoman commented Dec 15, 2023

mountiny commented Dec 15, 2023

WojtekBoman commented Dec 15, 2023 •

edited

Loading

s77rt commented Dec 15, 2023 •

edited

Loading

mountiny left a comment

OSBotify commented Dec 18, 2023

OSBotify commented Dec 19, 2023

OSBotify commented Dec 19, 2023

OSBotify commented Dec 21, 2023

OSBotify commented Dec 26, 2023

Ideal nav LHP #32473

Ideal nav LHP #32473

Conversation

WojtekBoman commented Dec 5, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 14, 2023

mountiny commented Dec 15, 2023

WojtekBoman commented Dec 15, 2023

mountiny commented Dec 15, 2023

WojtekBoman commented Dec 15, 2023 • edited Loading

s77rt commented Dec 15, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Dec 18, 2023

OSBotify commented Dec 19, 2023

OSBotify commented Dec 19, 2023

OSBotify commented Dec 21, 2023

OSBotify commented Dec 26, 2023

WojtekBoman commented Dec 5, 2023 •

edited

Loading

WojtekBoman commented Dec 15, 2023 •

edited

Loading

s77rt commented Dec 15, 2023 •

edited

Loading