Interface: WizardContextValue
Defined in: types.ts:96
Context value exposed by WizardProvider.
Properties
currentStep
currentStep:
number
Defined in: types.ts:100
Current active step index.
getStepStatus
getStepStatus: (
params) =>WizardStepStatus
Defined in: types.ts:128
Get the status of a step by index.
Parameters
| Parameter | Type |
|---|---|
params | { stepIndex: number; } |
params.stepIndex | number |
Returns
goToNext
goToNext: () =>
Promise<void>
Defined in: types.ts:108
Navigate to the next step.
Returns
Promise<void>
goToPrevious
goToPrevious: () =>
void
Defined in: types.ts:112
Navigate to the previous step.
Returns
void
goToStep
goToStep: (
params) =>void
Defined in: types.ts:116
Navigate to a specific step (only if it's completed or active).
Parameters
| Parameter | Type |
|---|---|
params | { stepIndex: number; } |
params.stepIndex | number |
Returns
void
isFirstStep
isFirstStep:
boolean
Defined in: types.ts:120
Whether the wizard is on the first step.
isLastStep
isLastStep:
boolean
Defined in: types.ts:124
Whether the wizard is on the last step.
setStepValidation
setStepValidation: (
validate) =>void
Defined in: types.ts:133
Register a validation function for the current step. This allows step content components to provide their own validation logic.
Parameters
| Parameter | Type |
|---|---|
validate | () => boolean | Promise<boolean> |
Returns
void
totalSteps
totalSteps:
number
Defined in: types.ts:104
Total number of steps.