Interface: WizardContextValue
Defined in: types.ts:75
Context value exposed by WizardProvider.
Properties
currentStep
currentStep:
number
Defined in: types.ts:79
Current active step index.
getStepStatus()
getStepStatus: (
params) =>WizardStepStatus
Defined in: types.ts:107
Get the status of a step by index.
Parameters
params
stepIndex
number
Returns
goToNext()
goToNext: () =>
Promise<void>
Defined in: types.ts:87
Navigate to the next step.
Returns
Promise<void>
goToPrevious()
goToPrevious: () =>
void
Defined in: types.ts:91
Navigate to the previous step.
Returns
void
goToStep()
goToStep: (
params) =>void
Defined in: types.ts:95
Navigate to a specific step (only if it's completed or active).
Parameters
params
stepIndex
number
Returns
void
isFirstStep
isFirstStep:
boolean
Defined in: types.ts:99
Whether the wizard is on the first step.
isLastStep
isLastStep:
boolean
Defined in: types.ts:103
Whether the wizard is on the last step.
setStepValidation()
setStepValidation: (
validate) =>void
Defined in: types.ts:112
Register a validation function for the current step. This allows step content components to provide their own validation logic.
Parameters
validate
() => boolean | Promise<boolean>
Returns
void
totalSteps
totalSteps:
number
Defined in: types.ts:83
Total number of steps.