[UXE-33] feat(Template) Creates DeleteWizard template package
#3291
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
🦋 Changeset detectedLatest commit: 7234f54 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 |
TheSonOfThomp
force-pushed
the
at/uxe-33-deletion-wizard
branch
from
b4510e3 to
baf8aff
Compare
bruugey
reviewed
Nov 7, 2025
TheSonOfThomp
force-pushed
the
at/wizard-integration
branch
from
5cf8c9b to
514e64f
Compare
TheSonOfThomp
force-pushed
the
at/uxe-33-deletion-wizard
branch
from
a036a5f to
e792cda
Compare
TheSonOfThomp
force-pushed
the
at/wizard-integration
branch
from
514e64f to
d8679f9
Compare
TheSonOfThomp
force-pushed
the
at/uxe-33-deletion-wizard
branch
2 times, most recently
from
def45eb to
3ebf987
Compare
TheSonOfThomp
force-pushed
the
at/wizard-integration
branch
from
d8679f9 to
cb44c9e
Compare
TheSonOfThomp
force-pushed
the
at/uxe-33-deletion-wizard
branch
4 times, most recently
from
75e9adb to
baf18eb
Compare
TheSonOfThomp
changed the base branch from
at/wizard-integration
to
LG-5562-wizard-updates
Contributor
|
Size Change: +53 B (0%) Total Size: 1.82 MB
ℹ️ View Unchanged
|
TheSonOfThomp
force-pushed
the
at/uxe-33-deletion-wizard
branch
from
1ddc91c to
1b9d0d3
Compare
TheSonOfThomp
force-pushed
the
LG-5562-wizard-updates
branch
from
2298793 to
cbb87fe
Compare
TheSonOfThomp
force-pushed
the
at/uxe-33-deletion-wizard
branch
2 times, most recently
from
e58a3d7 to
31abcc2
Compare
TheSonOfThomp
changed the title
DeletionWizard template package
TheSonOfThomp
changed the title
DeletionWizard template packageDeleteWizard template package
TheSonOfThomp
force-pushed
the
at/uxe-33-deletion-wizard
branch
3 times, most recently
from
89288ea to
518566d
Compare
This was referenced Nov 24, 2025
TheSonOfThomp
force-pushed
the
at/uxe-33-deletion-wizard
branch
2 times, most recently
from
940626d to
4e72a37
Compare
* update node * update node in actions yaml * Update release.yml * feat: Add initial publish instructions to package creation * printInitialPublishInstructions * changeset * changeset patch * Update initial publish instructions in README and DEVELOPER.md for clarity and consistency
TheSonOfThomp
force-pushed
the
at/uxe-33-deletion-wizard
branch
from
189443f to
bc1d02b
Compare
TheSonOfThomp
requested review from
Copilot,
shaneeza and
tsck
and removed request for
a team
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces the DeleteWizard template component, a specialized wizard implementation built on top of the existing Wizard component. It provides a structured, opinionated pattern for deletion confirmation flows with multiple steps.
Key Changes
- Creates a new
@leafygreen-ui/delete-wizardpackage with template-specific styling and behavior - Extends the
Wizardcomponent with context management, automatic button configuration, and specialized sub-components - Exports utility functions and test helpers from the
wizardpackage to support the new template
Reviewed changes
Copilot reviewed 24 out of 25 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/wizard/src/index.ts | Exports utility functions and constants needed by DeleteWizard |
| packages/wizard/src/WizardContext/WizardContext.tsx | Makes lgIds optional in WizardProvider props to support DeleteWizard's context extension |
| packages/delete-wizard/tsconfig.json | TypeScript configuration for the new package with workspace references |
| packages/delete-wizard/src/utils/getLgIds.ts | Utility to generate data-lgid attributes for DeleteWizard elements |
| packages/delete-wizard/src/testing/* | Test utilities for querying DeleteWizard elements in tests |
| packages/delete-wizard/src/testUtils/ExampleStepContent.tsx | Reusable example component for Storybook demonstrations |
| packages/delete-wizard/src/index.ts | Main package exports |
| packages/delete-wizard/src/DeleteWizard/* | Core DeleteWizard component implementation and sub-components |
| packages/delete-wizard/src/DeleteWizard.stories.tsx | Storybook stories demonstrating DeleteWizard usage |
| packages/delete-wizard/package.json | Package manifest with dependencies and build configuration |
| packages/delete-wizard/README.md | Package documentation |
| .changeset/delete-wizard.md | Changeset documenting the new feature |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
Comment on lines
+4
to
+8
| import { DeleteWizard } from '.'; | ||
|
|
||
| describe('packages/delete-wizard/getTestUtils', () => { | ||
| test('condition', () => {}); | ||
| }); |
There was a problem hiding this comment.
The test file contains only a placeholder test with no assertions. The getTestUtils function should have tests verifying that all returned utility functions (getDeleteWizard, queryDeleteWizard, findDeleteWizard, getHeader, queryHeader, findHeader, getActiveStep, queryActiveStep, findActiveStep) work correctly.
| /> | ||
| <DeleteWizard.Step requiresAcknowledgement> | ||
| <DeleteWizard.StepContent> | ||
| <div>Step 1 contents<div> |
There was a problem hiding this comment.
Unclosed div tag. The closing tag should be </div> instead of <div>.
Collaborator
Author
There was a problem hiding this comment.
👍 (just a README, but someone could copy it so I'll fix)
Suggested change
| <div>Step 1 contents<div> | |
| <div>Step 1 contents</div> |
tsck
reviewed
Dec 17, 2025
| */ | ||
| export const DeleteWizardHeader = CompoundSubComponent( | ||
| (props: CanvasHeaderProps & LgIdProps) => { | ||
| const { lgIds } = useDeleteWizardContext(); |
Collaborator
There was a problem hiding this comment.
In DeleteWizard the header is rendered outside of the DeleteWizardContextProvider. I don't believe the header actually has access to this context.
Collaborator
Author
There was a problem hiding this comment.
It'll have access to useDeleteWizardContext, but not useDeleteWizard**Step**Context
| /> | ||
| <DeleteWizard.Step requiresAcknowledgement> | ||
| <DeleteWizard.StepContent> | ||
| <div>Step 1 contents<div> |
packages/delete-wizard/README.md
Outdated
|
|
||
| ### DeleteWizard.StepContent | ||
|
|
||
| A styled `div` for use inside a `DeleteWizard.Step` to ensure proper page scrolling and footer positioning |
Collaborator
There was a problem hiding this comment.
I don't believe DeleteWizard.StepContent is actually an exported component
Collaborator
Author
There was a problem hiding this comment.
👍 forgot to update the docs
tsck
reviewed
Dec 17, 2025
Collaborator
There was a problem hiding this comment.
I forgot where we landed on changeset voice. Did we want this much information in the changeset?
Collaborator
Author
There was a problem hiding this comment.
In an initial changeset, I think this is appropriate
TheSonOfThomp
commented
Dec 19, 2025
TheSonOfThomp
commented
Dec 19, 2025
TheSonOfThomp
commented
Dec 19, 2025
Contributor
|
Coverage after merging at/uxe-33-deletion-wizard into main will be
Coverage Report for Changed Files
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.
Part of a PR train:
WizardAPI #3336Wizard#3338Integration branch: #3152
'@lg-templates/delete-wizard': minor
Initial release of
DeleteWizard.DeleteWizard
Establishes a context, and only renders the
activeStep(managed internally, or provided with theactiveStepprop). Accepts aDeleteWizard.Headerand any number ofDeleteWizard.Steps as children.DeleteWizardand all sub-components include template styling.DeleteWizard.Header
A convenience wrapper around
CanvasHeaderDeleteWizard.Step
A convenience wrapper around
Wizard.Stepto ensure the correct context.Like the basic
Wizard.Step, ofrequiresAcknowledgementis true, the step must haveisAcknowledgedset in context, (or passed in as a controlled prop) for the Footer's primary button to be enabled. (see the Wizard and DeleteWizard demos in Storybook)DeleteWizard.StepContent
A styled
divfor use inside aDeleteWizard.Stepto ensure proper page scrolling and footer positioningDeleteWizard.Footer
A wrapper around Wizard.Footer with embedded styles for the DeleteWizard template