Skip to content

fix(Wizard): Fix crash in nav when first sub-step is hidden #12166

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.

Sign up for GitHub

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

Open
ochosi wants to merge 1 commit into
base: main
Choose a base branch
from
+42 −3
Open

fix(Wizard): Fix crash in nav when first sub-step is hidden #12166

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions packages/react-core/src/components/Wizard/WizardNavInternal.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ export const WizardNavInternal = ({
let firstSubStepIndex: number;
let hasActiveChild = false;

const subNavItems = step.subStepIds?.map((subStepId, subStepIndex) => {
const subNavItems = step.subStepIds?.map((subStepId, _subStepIndex) => {
const subStep = steps.find((step) => step.id === subStepId);
const hasVisitedNextStep = steps.some((step) => step.index > subStep.index && step.isVisited);
const isSubStepDisabled =
Expand All @@ -66,8 +66,8 @@ export const WizardNavInternal = ({
return;
}

// Store the first sub-step index so that when its parent is clicked, the first sub-step is focused
if (subStepIndex === 0) {
// Store the first visible sub-step index so that when its parent is clicked, the first sub-step is focused
if (firstSubStepIndex === undefined) {
firstSubStepIndex = subStep.index;
}

Expand Down
39 changes: 39 additions & 0 deletions packages/react-core/src/components/Wizard/__tests__/Wizard.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -627,3 +627,42 @@ test('onStepChange skips over disabled or hidden steps and substeps', async () =
WizardStepChangeScope.Back
);
});

test('clicking parent step navigates to first visible sub-step when first sub-step is hidden', async () => {
const user = userEvent.setup();
const onStepChange = jest.fn();

render(
<Wizard onStepChange={onStepChange}>
<WizardStep id="step-1" name="Test step 1" />
<WizardStep
id="step-2"
name="Test step 2"
steps={[
<WizardStep id="step2-sub1" name="Hidden sub step" isHidden />,
<WizardStep id="step2-sub2" name="Visible sub step 1" />,
<WizardStep id="step2-sub3" name="Visible sub step 2" />
]}
/>
<WizardStep id="step-3" name="Test step 3" />
</Wizard>
);

// Navigate to step 3 first
await user.click(screen.getByRole('button', { name: 'Test step 3' }));
expect(onStepChange).toHaveBeenCalledWith(
null,
expect.objectContaining({ id: 'step-3' }),
expect.objectContaining({ id: 'step-1' }),
WizardStepChangeScope.Nav
);

// Click on parent step 2 - should navigate to the first VISIBLE sub-step (step2-sub2), not crash
await user.click(screen.getByRole('button', { name: 'Test step 2' }));
expect(onStepChange).toHaveBeenCalledWith(
null,
expect.objectContaining({ id: 'step2-sub2' }),
expect.objectContaining({ id: 'step-3' }),
WizardStepChangeScope.Nav
);
});
Loading