Interactive sub step header component #30415

gedu · 2023-10-26T08:32:32Z

Details

Step header component which is interactive, you can press on the completed ones or move to the next step using the ref

Fixed Issues

$ #30237
PROPOSAL: -

Tests

Verify that no errors appear in the JS console

Use Storybook

if you have the code: run it in the terminal npm run storybook

Default:
It shows the state of all the steps, completed, current and locked future steps

Clicking the step 1 (completed)
Step 2 should change style to locked one
Step 1 now shows the current step style
You can't click any of the future steps

Interactive:
You can move to future locked steps when clicking the Next button

Step 1 should show the current style
Click on the Next button to move from step 1 to 2
Step 1 shows the completed style and step 2 shows the current style
You can keep clicking the Next Button until all the steps are completed
clicking on a completed step, make the clicked one current and any future step locked
you can't click on future steps

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

Only on Storybook

interactive_step_header.mp4

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2023-10-26T08:32:38Z

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

gedu · 2023-10-26T14:28:16Z

@shubham1206agra can you review it so we can un-block the other pages?
cc: @mountiny

shubham1206agra · 2023-10-26T15:02:43Z

Getting this @gedu

shubham1206agra · 2023-10-26T15:43:32Z

After doing a quick patch, I am able to test this. After getting to step 5, I am unable to go back to any step. Is this intentional? (Just press next very quickly)
And I am seeing a lot of console errors. Can you correct this?

gedu · 2023-10-26T17:20:56Z

@shubham1206agra I just tested and I can go back and click on any of the steps, fixed some console errors, there are some that I think are more storybook-related but probably happen randomly. I will keep an eye tho

storybook.mp4

shubham1206agra · 2023-10-27T02:03:53Z

@shubham1206agra I just tested and I can go back and click on any of the steps, fixed some console errors, there are some that I think are more storybook-related but probably happen randomly. I will keep an eye tho
storybook.mp4

Now everything works correctly

shubham1206agra · 2023-10-27T02:09:03Z

Screen.Recording.2023-10-27.at.7.37.12.AM.mov

I will upload the checklist after sometime

shubham1206agra · 2023-10-27T05:11:14Z

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(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 reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Screen.Recording.2023-10-27.at.7.37.12.AM.mov

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

shubham1206agra · 2023-10-27T05:13:22Z

@gedu Can you add the steps for the tests and can you write comments about props you have added in the component?

gedu · 2023-10-27T05:52:48Z

@shubham1206agra Added comments and added the test steps

shubham1206agra · 2023-10-27T05:54:30Z

@gedu Can you check mark all the boxes?

gedu · 2023-10-27T06:34:27Z

@shubham1206agra done

shubham1206agra · 2023-10-27T10:12:50Z

@mountiny Please merge this

shubham1206agra · 2023-11-13T16:37:14Z

src/components/InteractiveStepSubHeader.js

+                            ]}
+                            disabled={isLockedStep}
+                            onPress={moveToStep}
+                            accessibilityRole={CONST.ACCESSIBILITY_ROLE.BUTTON}


@gedu We need to fix this line as this line will produce a warning now.

gedu added 4 commits October 25, 2023 15:14

Created Interactive Step Header

70e0056

replaced the console.warn with an Error

15bdfea

updated the text

a40c40f

Fixed comments

7150dbd

gedu requested a review from a team as a code owner October 26, 2023 08:32

melvin-bot bot requested review from shubham1206agra and removed request for a team October 26, 2023 08:32

gedu mentioned this pull request Oct 26, 2023

Created Interactive Step Header gedu/App#2

Closed

59 tasks

fixed some console errors

861db50

Added comments to the props

c506a61

shubham1206agra approved these changes Oct 27, 2023

View reviewed changes

melvin-bot bot requested a review from mountiny October 27, 2023 05:55

mountiny approved these changes Oct 27, 2023

View reviewed changes

mountiny merged commit 18d20f7 into Expensify:vit-tieredBankAccountFlow Oct 27, 2023
18 checks passed

shubham1206agra reviewed Nov 13, 2023

View reviewed changes

shubham1206agra mentioned this pull request Feb 26, 2024

[HOLD for payment 2024-03-08] Implement Tiered Business Bank Account flow #22901

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Interactive sub step header component #30415

Interactive sub step header component #30415

gedu commented Oct 26, 2023 •

edited

Loading

melvin-bot bot commented Oct 26, 2023

gedu commented Oct 26, 2023

shubham1206agra commented Oct 26, 2023

shubham1206agra commented Oct 26, 2023 •

edited

Loading

gedu commented Oct 26, 2023

shubham1206agra commented Oct 27, 2023

shubham1206agra commented Oct 27, 2023

shubham1206agra commented Oct 27, 2023 •

edited

Loading

shubham1206agra commented Oct 27, 2023

gedu commented Oct 27, 2023

shubham1206agra commented Oct 27, 2023

gedu commented Oct 27, 2023

shubham1206agra commented Oct 27, 2023

shubham1206agra Nov 13, 2023

Interactive sub step header component #30415

Interactive sub step header component #30415

Conversation

gedu commented Oct 26, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 26, 2023

gedu commented Oct 26, 2023

shubham1206agra commented Oct 26, 2023

shubham1206agra commented Oct 26, 2023 • edited Loading

gedu commented Oct 26, 2023

shubham1206agra commented Oct 27, 2023

shubham1206agra commented Oct 27, 2023

shubham1206agra commented Oct 27, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

shubham1206agra commented Oct 27, 2023

gedu commented Oct 27, 2023

shubham1206agra commented Oct 27, 2023

gedu commented Oct 27, 2023

shubham1206agra commented Oct 27, 2023

shubham1206agra Nov 13, 2023

Choose a reason for hiding this comment

gedu commented Oct 26, 2023 •

edited

Loading

shubham1206agra commented Oct 26, 2023 •

edited

Loading

shubham1206agra commented Oct 27, 2023 •

edited

Loading