Skip to main content

Interface: WizardProps

Defined in: types.ts:41

Props for the Wizard component.

Properties​

allowStepClick?​

optional allowStepClick?: boolean

Defined in: types.ts:76

Allow clicking on completed steps to navigate back. Defaults to true.

initialStep?​

optional initialStep?: number

Defined in: types.ts:71

The initially active step index. Defaults to 0.

labels?​

optional labels?: Partial<WizardLabels>

Defined in: types.ts:80

Optional custom labels for the navigation buttons.

layout?​

optional layout?: WizardLayout

Defined in: types.ts:49

Position of the step list. Defaults to 'top'.

onCancel?​

optional onCancel?: () => void

Defined in: types.ts:63

Called when the user clicks "Cancel". If not provided, the Cancel button is not rendered.

Returns​

void

onComplete?​

optional onComplete?: () => void

Defined in: types.ts:58

Called when the wizard completes (user clicks "Finish" on the last step).

Returns​

void

onStepChange?​

optional onStepChange?: (params) => void

Defined in: types.ts:67

Called whenever the active step changes.

Parameters​

ParameterType
params{ stepIndex: number; }
params.stepIndexnumber

Returns​

void

steps​

steps: WizardStep[]

Defined in: types.ts:45

Array of steps to display in the wizard.

variant?​

optional variant?: WizardVariant

Defined in: types.ts:54

Visual variant for the wizard shell, step accents, and primary action.

Default​

'spotlight-accent'