[LG-5562] feat(Wizard) Updates Wizard API
#3336
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
private endpoints useFetchRequiredActionTableData renam ReqAct cards composable basic table stream processing card federated db card applications card clusters card wizard step context Delete requiredActionsConfig.tsx re-enable wizard add useRequiredActionAcknowledgements mv required action. add skeleton Update ModelApiKeysCard.tsx
Update package.json
TheSonOfThomp
requested review from
stephl3 and
tsck
and removed request for
a team
🦋 Changeset detectedLatest commit: 4b32ed6 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
|
Size Change: +445 B (+0.02%) Total Size: 1.8 MB
ℹ️ View Unchanged
|
TheSonOfThomp
force-pushed
the
LG-5562-wizard-updates
branch
from
2298793 to
cbb87fe
Compare
TheSonOfThomp
changed the title
Wizard API for simpler implementation
This was referenced Nov 24, 2025
TheSonOfThomp
changed the title
Wizard API for simpler implementationWizard API
shaneeza
reviewed
Nov 25, 2025
Collaborator
shaneeza
left a comment
shaneeza
left a comment
There was a problem hiding this comment.
Looks good! I mostly left minor comments as well as some comments in chromatic.
shaneeza
approved these changes
Nov 25, 2025
Contributor
|
Coverage after merging LG-5562-wizard-updates into at/wizard-integration will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TheSonOfThomp
added a commit
that referenced
this pull request
Nov 26, 2025
* rm step wrapper * rm descendants dep * export WizardProvider * delete-wizard-demo private endpoints useFetchRequiredActionTableData renam ReqAct cards composable basic table stream processing card federated db card applications card clusters card wizard step context Delete requiredActionsConfig.tsx re-enable wizard add useRequiredActionAcknowledgements mv required action. add skeleton Update ModelApiKeysCard.tsx * Update pnpm Update package.json * fix wizard changes * Adds `requiresAcknowledgement` prop to Wizard.Step * Implements `isAcknowledged` state inside provider * Update Wizard.stories.tsx * rm delete demo * Update wizard.md * rm temp changesets * Update README.md * Update WizardStep.spec.tsx * footer tests * Update Wizard.spec.tsx * update package json * update provider props * revert toast changes? * Update .npmrc * Update pnpm-lock.yaml * Update WizardStep.spec.tsx * exports form footer types * Update WizardFooter.types.ts * adds `totalSteps` to wizard context * fix bad merge * updates readme * updates tsdoc * fixes tests * fixes ack reset test * Update WizardStep.spec.tsx * fixes stories
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
✍️ Proposed changes
Part of a PR train:
Wizard#3338DeleteWizardtemplate package #3291Integration branch: #3152
'@leafygreen-ui/wizard': minor
Initial Wizard package release.
Wizard
The
Wizardcomponent establishes a context with an internal state, and will render only theactiveStep.You can also control the Wizard externally using the
activeStepandonStepChangecallback.Note: if you externally control the state, you opt out of the automatic range validation, and you must ensure that the provided
activeStepindex is valid relative to theWizard.Steps provided.Wizard.Step
Defines a discrete step in the wizard. Only the step matching the internal (or provided)
activeStepindex will be displayed.Both
WizardandWizard.Stepare only wrapped in aFragmentto allow for more versatile styling.requiresAcknowledgementIf
requiresAcknowledgementis true, the step must haveisAcknowledgedset in context, (or passed in as a controlled prop) for the Footer's primary button to be enabled.e.g.
Wizard.Footer
The
Wizard.Footeris a convenience wrapper around theFormFootercomponent. Each step should render its own Footer component