Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pass WorkflowCard props to every screen component #469

Merged
merged 12 commits into from
Sep 20, 2023

Conversation

ektaghag-eaton
Copy link
Contributor

@ektaghag-eaton ektaghag-eaton commented Sep 11, 2023

Fixes BLUI-4694 .

Changes proposed in this Pull Request:

  • Pass WorkflowCard props to every screen component
  • Make divider default true
  • Update docs

Screenshots / Screen Recording (if applicable)

To Test:

Any specific feedback you are looking for?

-1. By default, making the divider value true so if the user wants to hide the divider needs to pass code like the below:
<VerifyCodeScreen
WorkflowCardInstructionProps={{
instructions: 'Test Instruction',
divider: false,
}}
WorkflowCardActionsProps={{
divider: false,
}}
/>

  1. Every screen should have WorkflowCardBaseProps, WorkflowCardHeaderProps, WorkflowCardInstructionProps and WorkflowCardActionsProps

Note: For testing purpose, I have added code snippets for every component in AppRouter Please uncomment code while testing along with the default behaviour.

@github-actions github-actions bot added the brightlayer-ui Used to identify Brightlayer UI platform issues for easy filtering label Sep 11, 2023
@github-actions
Copy link

github-actions bot commented Sep 11, 2023

Visit the preview URL for this PR (updated for commit 41a3480):

https://blui-react-login--pr469-fix-blui-4694-workfl-l1cp299e.web.app

(expires Fri, 22 Sep 2023 10:24:31 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: 1e9064d2e35ed37fe01e053587ea5f209719a043

Copy link
Collaborator

@surajeaton surajeaton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please resolve the conflicts.

@ektaghag-eaton
Copy link
Contributor Author

WorkflowCardBaseProps

Done please review

@JeffGreiner-eaton
Copy link
Collaborator

for some reason I can't do inline comments in this PR, but for workflowCardInstructions type for divider we can add @default true to the type doc section.

/**
* Whether or not to show a divider below the instructions
* @default true
*/
divider?: boolean;

Copy link
Collaborator

@surajeaton surajeaton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please resolve the conflicts

Copy link
Collaborator

@surajeaton surajeaton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lint is failing.

@ektaghag-eaton
Copy link
Contributor Author

for some reason I can't do inline comments in this PR, but for workflowCardInstructions type for divider we can add @default true to the type doc section.

/** * Whether or not to show a divider below the instructions * @default true */ divider?: boolean;

@JeffGreiner-eaton and @surajeaton fixed PR comments. Please review.

Copy link
Collaborator

@surajeaton surajeaton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.
Make sure to undo the changes did for testing before merging.

@JeffGreiner-eaton
Copy link
Collaborator

Looks good. Make sure to undo the changes did for testing before merging.

@ektaghag-eaton please update app router test code

@joebochill
Copy link
Collaborator

Looks fine to me. I might've opted to go with a single WorkflowCardProps prop with keys for each of the Base, Instructions, etc. for a slightly cleaner look in the DOM, but it would complicate the destructuring in all of the screens, so this works fine as is.

@ektaghag-eaton ektaghag-eaton merged commit 49f1996 into dev Sep 20, 2023
2 checks passed
@ektaghag-eaton ektaghag-eaton deleted the fix/blui-4694-workflow-card-issue branch September 20, 2023 10:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
brightlayer-ui Used to identify Brightlayer UI platform issues for easy filtering
Development

Successfully merging this pull request may close these issues.

4 participants