Skip to main content

Interface: WizardProps

Defined in: types.ts:39

Props for the Wizard component.

Properties​

allowStepClick?​

optional allowStepClick: boolean

Defined in: types.ts:69

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

initialStep?​

optional initialStep: number

Defined in: types.ts:64

The initially active step index. Defaults to 0.

layout?​

optional layout: WizardLayout

Defined in: types.ts:47

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

onCancel()?​

optional onCancel: () => void

Defined in: types.ts:56

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:51

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

Returns​

void

onStepChange()?​

optional onStepChange: (params) => void

Defined in: types.ts:60

Called whenever the active step changes.

Parameters​

params​
stepIndex​

number

Returns​

void

steps​

steps: WizardStep[]

Defined in: types.ts:43

Array of steps to display in the wizard.