Feat/placeholder web #29092

b4s36t4 · 2023-10-09T14:28:04Z

Details

Added a new placeholder component for using with small-screen devices to show when opened particular screen on mobile devices.

Fixed Issues

$ #28982
PROPOSAL: #28982 (comment)

Tests

Verify that no errors appear in the JS console
NA

Offline tests

NA

QA Steps

Verify that no errors appear in the JS console
NA

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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

web.mp4

Mobile Web - Chrome

chrome-web.mp4

Mobile Web - Safari

safari.mp4

Desktop

desktop.mp4

iOS

ios.mp4

Android

android.mp4

…-web

melvin-bot · 2023-10-09T14:28:10Z

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

b4s36t4 · 2023-10-09T14:28:28Z

@hayata-suenaga @ArekChr please review.

hayata-suenaga · 2023-10-10T01:33:03Z

@b4s36t4 please fix the lint error 🙇

b4s36t4 · 2023-10-10T03:38:38Z

@hayata-suenaga done.

src/components/Temp/Temp.js

ArekChr · 2023-10-10T08:43:51Z

src/components/Temp/Temp.js

+    onLinkPress: () => Navigation.dismissModal(),
+};
+
+function Temp({titleKey, subtitleKey, linkKey, onLinkPress, children, shouldShow}) {


This could be called WideScreenContent, LargeDisplayWrapper or similar

LargeDisplayWrapper This seems promising for me. @hayata-suenaga What's your thought?

is this a test component for testing the display of the blocking view or is this The blocking view?

src/components/Temp/Temp.js

ArekChr · 2023-10-10T08:44:54Z

src/components/Temp/Temp.js

+    onLinkPress: PropTypes.func,
+};
+
+const defaultProps = {


prop for setting min width could be useful, @hayata-suenaga wdyt?

src/components/Temp/Temp.js

src/components/LargeDisplayWrapper/LargeDisplayWrapper.js

ArekChr · 2023-10-10T10:59:36Z

src/components/LargeDisplayWrapper/LargeDisplayWrapper.js

+    children: PropTypes.node,
+
+    /** If true, child components are replaced with a blocking "not found" view */
+    shouldShow: PropTypes.bool,


Maybe shouldBlockContent will be more intuitive, WDYT?

Yes, I think considering component name and the way we handle it sounds good. @hayata-suenaga your view?

yes that name sounds good 👍 but why do we need a prop for it? This component already subscribes to the screen size. So the information whether to display the blocking view (this component) is already inside the component?

or is this just a test component?

I agree, as for now, this is not needed. Until such a use case is needed, I believe we should remove all unnecessary props. IMO, this component should be as simple as possible. In the future, if there is a need to block content in a different scenario than the display size condition, it should then be implemented for specific requirements.

src/components/BlockingViews/FullPageNotFoundView.js

hayata-suenaga · 2023-10-10T12:33:52Z

src/SCREENS.ts

@@ -24,6 +24,7 @@ export default {
    SIGN_IN_WITH_APPLE_DESKTOP: 'AppleSignInDesktop',
    SIGN_IN_WITH_GOOGLE_DESKTOP: 'GoogleSignInDesktop',
    DESKTOP_SIGN_IN_REDIRECT: 'DesktopSignInRedirect',
+    MOBILE_TEMP_SCREEN: 'MobilePlaceHolder',


@b4s36t4 I'm not familiar with the navigation system but why do we need this blocking component as a new screen?

isn't the new component just displayed when the screen size is small in another component?

This component shouldn't be registered as a new screen

b4s36t4 · 2023-10-10T14:05:31Z

@hayata-suenaga @ArekChr Updated everything. can you guys please check?!!

Spanish translations are not yet verified.

src/components/LargeDisplayWrapper/LargeDisplayWrapper.js

b4s36t4 · 2023-10-11T18:42:34Z

@hayata-suenaga @ArekChr What are we going to do about screen. If we follow NotFound page we need to register as a screen to support (dismissModal). Or we need to confirm weather we need to pop the screen (which we show this component using goBack) or push the user to / Report Route. Once this is done we are good to go I think.

…-web

ArekChr · 2023-10-12T13:52:32Z

@hayata-suenaga @ArekChr What are we going to do about screen. If we follow NotFound page we need to register as a screen to support (dismissModal). Or we need to confirm weather we need to pop the screen (which we show this component using goBack) or push the user to / Report Route. Once this is done we are good to go I think.

I believe this component will primarily serve as a part of another screen to prevent content display when necessary. Consequently:

In desktop browsers, the default 'go back' functionality should suffice for navigation when content is blocked.
For mobile, using the back gesture or back button on bottom navigation in Android to manage on-screen navigation during content blocking seems apt.
This ensures we uphold intuitive navigation practices respective to the platform being used.

NotFound screen is also used in side bar which handles more complex scenarios. Will we use this component in modals? Are there some requirements? @hayata-suenaga

hayata-suenaga · 2023-10-15T23:47:32Z

I believe this component will primarily serve as a part of another screen to prevent content display when necessary.

@b4s36t4 yes this is true. I don't think we need to register the component as a screen

b4s36t4 · 2023-10-16T20:20:16Z

@hayata-suenaga @ArekChr Please check now, removed screen related changes also made onLinkPress prop with default value to goBack.

Let me know if there's anything needed.

…-web

ArekChr

Overall, the code looks good to me, giving approval.

Also I propose making this component as simple as possible, WDYT @hayata-suenaga?

ArekChr · 2023-10-17T10:39:41Z

src/components/LargeDisplayWrapper/LargeDisplayWrapper.js

+
+    /** If true, child components are replaced with a blocking view */
+    shouldBlockContent: PropTypes.bool,


I think we don't need that for now, cc: @hayata-suenaga

Suggested change

/** If true, child components are replaced with a blocking view */

shouldBlockContent: PropTypes.bool,

ArekChr · 2023-10-17T10:40:07Z

src/components/LargeDisplayWrapper/LargeDisplayWrapper.js

+    const shouldShowBlockingView = _.isBoolean(shouldBlockContent) ? shouldBlockContent : isSmallScreenWidth;
+
+    if (shouldShowBlockingView) {


Suggested change

const shouldShowBlockingView = _.isBoolean(shouldBlockContent) ? shouldBlockContent : isSmallScreenWidth;

if (shouldShowBlockingView) {

if (isSmallScreenWidth) {

ArekChr · 2023-10-17T10:40:30Z

src/components/LargeDisplayWrapper/LargeDisplayWrapper.js

+    const {isSmallScreenWidth} = useWindowDimensions();
+
+    const {translate} = useLocalize();


nit style

Suggested change

const {isSmallScreenWidth} = useWindowDimensions();

const {translate} = useLocalize();

const {translate} = useLocalize();

const {isSmallScreenWidth} = useWindowDimensions();

ArekChr · 2023-10-17T10:41:31Z

src/components/LargeDisplayWrapper/LargeDisplayWrapper.js

+
+    /** Action to run when clicked on a the link text */
+    onLinkPress: PropTypes.func,


Let's keep is simple as possible. Cc: @hayata-suenaga

Suggested change

/** Action to run when clicked on a the link text */

onLinkPress: PropTypes.func,

ArekChr · 2023-10-17T10:41:42Z

src/components/LargeDisplayWrapper/LargeDisplayWrapper.js

+    shouldBlockContent: undefined,
+    onLinkPress: () => Navigation.goBack(),


Suggested change

shouldBlockContent: undefined,

onLinkPress: () => Navigation.goBack(),

ArekChr · 2023-10-17T10:41:52Z

src/components/LargeDisplayWrapper/LargeDisplayWrapper.js

+                    subtitle={translate('mobilePlacerHolder.subTitle')}
+                    linkKey={translate('mobilePlacerHolder.goBackHome')}
+                    shouldShowLink
+                    onLinkPress={onLinkPress}


Suggested change

onLinkPress={onLinkPress}

onLinkPress={Navigation.goBack}

hayata-suenaga · 2023-10-17T12:10:47Z

The author of this PR used the code in their PR.

So we don't have to merge or deploy this PR. Thank you everyone for work. You gonna receive a normal payment. We just don't use this PR.

b4s36t4 added 3 commits October 6, 2023 19:27

create initial placeholder component

69eb597

Merge branch 'main' of github.com:Expensify/App into feat/placeholder…

674c80c

…-web

temp component

f6b3941

b4s36t4 requested a review from a team as a code owner October 9, 2023 14:28

melvin-bot bot requested review from ArekChr and removed request for a team October 9, 2023 14:28

remove unused styling

e1ba6df

ArekChr reviewed Oct 10, 2023

View reviewed changes

src/components/Temp/Temp.js Outdated Show resolved Hide resolved

ArekChr reviewed Oct 10, 2023

View reviewed changes

src/components/Temp/Temp.js Outdated Show resolved Hide resolved

ArekChr reviewed Oct 10, 2023

View reviewed changes

src/components/Temp/Temp.js Outdated Show resolved Hide resolved

ArekChr reviewed Oct 10, 2023

View reviewed changes

src/components/Temp/Temp.js Outdated Show resolved Hide resolved

fix conditional

0629827

ArekChr reviewed Oct 10, 2023

View reviewed changes

src/components/LargeDisplayWrapper/LargeDisplayWrapper.js Outdated Show resolved Hide resolved

ArekChr reviewed Oct 10, 2023

View reviewed changes

src/components/LargeDisplayWrapper/LargeDisplayWrapper.js Outdated Show resolved Hide resolved

ArekChr reviewed Oct 10, 2023

View reviewed changes

fix suggestions

4ff72cb

hayata-suenaga reviewed Oct 10, 2023

View reviewed changes

src/components/BlockingViews/FullPageNotFoundView.js Outdated Show resolved Hide resolved

hayata-suenaga reviewed Oct 10, 2023

View reviewed changes

add translations & fixes

f280551

ArekChr reviewed Oct 11, 2023

View reviewed changes

src/components/LargeDisplayWrapper/LargeDisplayWrapper.js Outdated Show resolved Hide resolved

b4s36t4 added 2 commits October 11, 2023 17:47

remove unused prop

d350544

update spanish translations

bf51ab2

b4s36t4 added 3 commits October 12, 2023 00:18

Merge branch 'main' of github.com:Expensify/App into feat/placeholder…

64981ad

…-web

Merge branch 'main' of github.com:Expensify/App into feat/placeholder…

736d176

…-web

Merge branch 'main' of github.com:Expensify/App into feat/placeholder…

7e08ad6

…-web

remove screen related changes

fe65554

Merge branch 'main' of github.com:Expensify/App into feat/placeholder…

eb11fe0

…-web

ArekChr approved these changes Oct 17, 2023

View reviewed changes

melvin-bot bot requested a review from hayata-suenaga October 17, 2023 10:51

hayata-suenaga closed this Oct 17, 2023

hayata-suenaga mentioned this pull request Oct 17, 2023

[$500] Create a new placeholder component #28982

Closed

b4s36t4 deleted the feat/placeholder-web branch October 17, 2023 14:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat/placeholder web #29092

Feat/placeholder web #29092

b4s36t4 commented Oct 9, 2023

melvin-bot bot commented Oct 9, 2023

b4s36t4 commented Oct 9, 2023

hayata-suenaga commented Oct 10, 2023

b4s36t4 commented Oct 10, 2023

ArekChr Oct 10, 2023

b4s36t4 Oct 10, 2023

hayata-suenaga Oct 10, 2023

ArekChr Oct 10, 2023

ArekChr Oct 10, 2023

b4s36t4 Oct 10, 2023 •

edited

Loading

hayata-suenaga Oct 10, 2023

hayata-suenaga Oct 10, 2023

ArekChr Oct 11, 2023

hayata-suenaga Oct 10, 2023

ArekChr Oct 11, 2023

b4s36t4 commented Oct 10, 2023

b4s36t4 commented Oct 11, 2023

ArekChr commented Oct 12, 2023

hayata-suenaga commented Oct 15, 2023

b4s36t4 commented Oct 16, 2023

ArekChr left a comment

ArekChr Oct 17, 2023

ArekChr Oct 17, 2023

ArekChr Oct 17, 2023

ArekChr Oct 17, 2023

ArekChr Oct 17, 2023

ArekChr Oct 17, 2023

hayata-suenaga commented Oct 17, 2023


		/** If true, child components are replaced with a blocking view */
		shouldBlockContent: PropTypes.bool,

		const shouldShowBlockingView = _.isBoolean(shouldBlockContent) ? shouldBlockContent : isSmallScreenWidth;

		if (shouldShowBlockingView) {

		const {isSmallScreenWidth} = useWindowDimensions();

		const {translate} = useLocalize();


		/** Action to run when clicked on a the link text */
		onLinkPress: PropTypes.func,

		shouldBlockContent: undefined,
		onLinkPress: () => Navigation.goBack(),

Feat/placeholder web #29092

Feat/placeholder web #29092

Conversation

b4s36t4 commented Oct 9, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 9, 2023

b4s36t4 commented Oct 9, 2023

hayata-suenaga commented Oct 10, 2023

b4s36t4 commented Oct 10, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

b4s36t4 Oct 10, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

b4s36t4 commented Oct 10, 2023

b4s36t4 commented Oct 11, 2023

ArekChr commented Oct 12, 2023

hayata-suenaga commented Oct 15, 2023

b4s36t4 commented Oct 16, 2023

ArekChr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hayata-suenaga commented Oct 17, 2023

b4s36t4 Oct 10, 2023 •

edited

Loading