New preferences page layout #21852

roryabraham · 2023-06-29T04:06:09Z

HOLD on #20663

Details

This PR was split off of #15462. It implements a new layout in the Settings -> Preferences page.

Fixed Issues

$ (partial) #12261

Tests

Open the preferences page.
Make sure it matches the screenshots.
Test the UI for regressions.

Verify that no errors appear in the JS console

Offline tests

Same as tests.

QA Steps

Same as tests.

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

web.mov

Mobile Web - Chrome

androidWeb.mov

Mobile Web - Safari

iOSWeb.mov

Desktop

desktop.mov

iOS

iOS.mov

Android

android.mov

roryabraham · 2023-06-29T04:11:12Z

This PR is branched off of #20663, so the diff will be smaller once that's merged.

melvin-bot · 2023-06-29T18:40:23Z

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

roryabraham · 2023-06-29T18:43:23Z

@allroundexperts is going to review this

allroundexperts · 2023-06-29T18:44:46Z

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 / Chrome
- iOS / native
- iOS / 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 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

Web

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

Mobile Web - Chrome

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

Mobile Web - Safari

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

Desktop

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

iOS

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

Android

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

roryabraham · 2023-06-29T18:46:07Z

patches/react-native-web-lottie+1.4.4.patch

+       container: this.animationDOMNode,
+       animationData: props.source,
+-      renderer: 'svg',
+      renderer: 'canvas',


I found this seems to yield better framerates and also fixes a display but on iOS Safari with different animation (not yet included in the app)

I noticed that on android web, the animation was extremely janky. When running it against localhost, it did not simply load.

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

src/components/HeaderWithBackButton/index.js

allroundexperts · 2023-06-29T19:43:07Z

Make sure it matches the screenshots.

@roryabraham Can you post the screenshots? I saw some screenshots in the linked issue but since this is a partial implementation, it would be good to have the screenshots that this PR is implementing.

roryabraham · 2023-06-29T19:54:11Z

@allroundexperts refresh the page maybe? GitHub was having issues but I posted all the screenshots before putting this in for review. I can still see them in the issue description

roryabraham · 2023-07-14T22:42:23Z

@allroundexperts all fixed now

src/components/withEnvironment.js

allroundexperts · 2023-07-16T20:23:03Z

src/components/withEnvironment.js

+export default function withEnvironment(WrappedComponent) {
+    const WithEnvironment = forwardRef((props, ref) => {
+        const {environment, environmentURL} = useContext(EnvironmentContext);
        return (
            <WrappedComponent
                // eslint-disable-next-line react/jsx-props-no-spreading
                {...props}
-                ref={props.forwardedRef}
+                ref={ref}
                environment={environment}
                environmentURL={environmentURL}
            />
        );
-    }
+    });

    WithEnvironment.displayName = `withEnvironment(${getComponentDisplayName(WrappedComponent)})`;
-    WithEnvironment.propTypes = {
-        forwardedRef: PropTypes.oneOfType([PropTypes.func, PropTypes.shape({current: PropTypes.instanceOf(React.Component)})]),
-    };
-    WithEnvironment.defaultProps = {
-        forwardedRef: undefined,
-    };
-    return React.forwardRef((props, ref) => (
-        <WithEnvironment
-            // eslint-disable-next-line react/jsx-props-no-spreading
-            {...props}
-            forwardedRef={ref}
-        />
-    ));
+
+    return WithEnvironment;


I think its better to add this function into a separate file. Also, if this HoC isn't being used at a lot of places, it might be a better idea to just get rid of it. I see that you've already created a hook for this.

allroundexperts · 2023-07-16T20:37:29Z

src/hooks/useEnvironment.js

    return {
        environment,
        environmentURL,
+        isProduction: environment === CONST.ENVIRONMENT.PRODUCTION,


This can be part of the context value as well!

would be happy to address this in a follow-up 👍🏼

I realize that this makes it so that the hook has to copy the object from the return value of useContext every time, which is a waste.

allroundexperts

Solid work @roryabraham!

I have left some minor comments. However, you can merge this if you feel like those are not urgent enough to be addressed.

melvin-bot · 2023-07-16T20:43:21Z

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

MonilBhavsar

Looks good to me.

src/components/HeaderWithBackButton/index.js

roryabraham · 2023-07-17T17:53:02Z

TIL about git mv, thanks @MonilBhavsar!

and thanks for the comments @allroundexperts. I think there's a number of good thoughts there but it's more important to get this merged so I can implement the other pages soon here.

OSBotify · 2023-07-17T17:56:48Z

✋ 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-07-17T19:37:53Z

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

platform	result
🤖 android 🤖	cancelled 🔪
🖥 desktop 🖥	cancelled 🔪
🍎 iOS 🍎	cancelled 🔪
🕸 web 🕸	cancelled 🔪

mountiny · 2023-07-18T20:35:06Z

src/components/HeaderWithBackButton/index.js

+                <View style={[styles.reportOptions, styles.flexRow, styles.pr5, styles.alignItemsCenter]}>
+                    {shouldShowDownloadButton && (


This refactor has caused a deploy blocker #23129 as we have forgot to pass the children which was a change made in the deleted file but probably did not cause morege conflicts or it was missed when resolved.

Yes, my bad I missed that change when resolving conflicts

OSBotify · 2023-07-19T17:59:38Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.42-26 🚀

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

aimane-chnaif · 2023-07-20T14:12:20Z

src/components/Pressable/PressableWithDelayToggle.js

-
-    ...withDelayToggleButtonStatePropTypes,
+    /** Ref passed to the component by React.forwardRef (do not pass from parent) */
+    innerRef: PropTypes.oneOfType([PropTypes.func, PropTypes.shape({current: PropTypes.instanceOf(React.Component)})]).isRequired,


Coming from #23093: Is there reason to make this prop required?

My reasoning was that since it's always passed by forwardRef, then it would make sense to have it be required. However I see now that it will be null/undefined if the parent doesn't pass a ref.

neil-marcellini · 2023-08-02T14:12:23Z

As per the checklist, this PR caused this regression #23102. It's explained here, but TLDR is that some code was removed previously and accidentally added back here which broke navigating to the parent report.

sobitneupane · 2023-10-09T06:31:29Z

This minor issue was probably missed in the PR.

Issue: Preferences - Shows blue color in Bottom Safearea when going offline

Steps to reproduce:

Go offline in IOS/native
Go to settings -> Go to preferences
See bottom Safearea

roryabraham self-assigned this Jun 29, 2023

roryabraham added 9 commits June 28, 2023 21:15

Add asset for PreferencesDJ.json

1dac0bc

Aggregate LottieAnimations in a single file

7c9774b

Extract HeaderWithBackButton propTypes to separate file

0d94495

Convert to functional component

7b28fe4

Implement useDelayToggleButtonState hook

122f2c2

Create IllustratedHeaderPageLayout component

44ff6c8

Implement IllustratedHeaderPageLayout for the PreferencesPage

b8d6631

Use useLocalize hook

33c8378

Create useEnvironment hook

090ae41

roryabraham force-pushed the Rory-PreferencesNewLayout branch from d30cca4 to 090ae41 Compare June 29, 2023 04:15

Merge branch 'main' into Rory-PreferencesNewLayout

9ab59ba

roryabraham changed the title ~~[HOLD] New preferences page layout~~ [WIP] New preferences page layout Jun 29, 2023

roryabraham added the Ready To Build label Jun 29, 2023

Use canvas renderer instead of svg

ccaaa31

roryabraham changed the title ~~[WIP] New preferences page layout~~ New preferences page layout Jun 29, 2023

roryabraham marked this pull request as ready for review June 29, 2023 18:39

roryabraham requested a review from a team as a code owner June 29, 2023 18:39

melvin-bot bot requested review from stitesExpensify and removed request for a team June 29, 2023 18:40

roryabraham requested review from shawnborton and allroundexperts June 29, 2023 18:41

roryabraham commented Jun 29, 2023

View reviewed changes

src/components/HeaderWithBackButton/index.js Show resolved Hide resolved

Remove unused prop

1e2a9a3

allroundexperts reviewed Jul 16, 2023

View reviewed changes

src/components/withEnvironment.js Show resolved Hide resolved

allroundexperts reviewed Jul 16, 2023

View reviewed changes

allroundexperts approved these changes Jul 16, 2023

View reviewed changes

melvin-bot bot requested a review from MonilBhavsar July 16, 2023 20:43

MonilBhavsar approved these changes Jul 17, 2023

View reviewed changes

src/components/HeaderWithBackButton/index.js Show resolved Hide resolved

roryabraham merged commit c735121 into main Jul 17, 2023
14 of 18 checks passed

roryabraham deleted the Rory-PreferencesNewLayout branch July 17, 2023 17:53

OSBotify mentioned this pull request Jul 17, 2023

Deploy Checklist: New Expensify 2023-07-17 #23033

Closed

situchan mentioned this pull request Jul 18, 2023

[HOLD for payment 2023-07-26] Connect Bank - Connect bank account step counter disappeared #23091

Closed

6 tasks

mountiny mentioned this pull request Jul 18, 2023

[CP Staging] Fix missing settlement button #23129

Merged

58 tasks

mountiny reviewed Jul 18, 2023

View reviewed changes

roryabraham mentioned this pull request Jul 18, 2023

[HOLD for payment 2023-07-28] [HOLD for payment 2023-07-26] [$1000] Settings - Menu items are blocked after clicking on them and returning back #23052

Closed

6 tasks

aimane-chnaif mentioned this pull request Jul 20, 2023

[Awaiting C+ payment confirmation] [HOLD for payment 2023-08-16] [$1000] IOS - Getting console warning on Contact methods page #23093

Closed

6 tasks

aimane-chnaif reviewed Jul 20, 2023

View reviewed changes

allroundexperts mentioned this pull request Aug 22, 2023

Better default empty states with animation #12261

Closed

sobitneupane mentioned this pull request Sep 6, 2023

[HOLD for payment 2023-10-02] [$500] Preferences - Shows blue color in Bottom Safearea when going offline #26425

Closed

6 tasks

0xmiros mentioned this pull request Sep 6, 2023

[HOLD for payment 2023-09-06] [$500] Inconsistent bottom space between Workspace page and other pages. #24378

Closed

6 tasks

samh-nl mentioned this pull request Sep 25, 2023

[HOLD for payment 2023-10-13] [$500] Inconsistensy Bug - vertical scroll Bar #26098

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New preferences page layout #21852

New preferences page layout #21852

roryabraham commented Jun 29, 2023 •

edited

Loading

roryabraham commented Jun 29, 2023

melvin-bot bot commented Jun 29, 2023

roryabraham commented Jun 29, 2023

allroundexperts commented Jun 29, 2023 •

edited

Loading

roryabraham Jun 29, 2023

allroundexperts Jul 16, 2023

allroundexperts commented Jun 29, 2023

roryabraham commented Jun 29, 2023

roryabraham commented Jul 14, 2023

allroundexperts Jul 16, 2023 •

edited

Loading

allroundexperts Jul 16, 2023

roryabraham Jul 17, 2023

allroundexperts left a comment

melvin-bot bot commented Jul 16, 2023

MonilBhavsar left a comment

roryabraham commented Jul 17, 2023

OSBotify commented Jul 17, 2023

OSBotify commented Jul 17, 2023

mountiny Jul 18, 2023

roryabraham Jul 19, 2023

OSBotify commented Jul 19, 2023

aimane-chnaif Jul 20, 2023

roryabraham Jul 20, 2023

neil-marcellini commented Aug 2, 2023

sobitneupane commented Oct 9, 2023

		<View style={[styles.reportOptions, styles.flexRow, styles.pr5, styles.alignItemsCenter]}>
		{shouldShowDownloadButton && (

New preferences page layout #21852

New preferences page layout #21852

Conversation

roryabraham commented Jun 29, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

roryabraham commented Jun 29, 2023

melvin-bot bot commented Jun 29, 2023

roryabraham commented Jun 29, 2023

allroundexperts commented Jun 29, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

Choose a reason for hiding this comment

Choose a reason for hiding this comment

allroundexperts commented Jun 29, 2023

roryabraham commented Jun 29, 2023

roryabraham commented Jul 14, 2023

allroundexperts Jul 16, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

allroundexperts left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Jul 16, 2023

MonilBhavsar left a comment

Choose a reason for hiding this comment

roryabraham commented Jul 17, 2023

OSBotify commented Jul 17, 2023

OSBotify commented Jul 17, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OSBotify commented Jul 19, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neil-marcellini commented Aug 2, 2023

sobitneupane commented Oct 9, 2023

roryabraham commented Jun 29, 2023 •

edited

Loading

allroundexperts commented Jun 29, 2023 •

edited

Loading

allroundexperts Jul 16, 2023 •

edited

Loading