Interface WizardStep

interface WizardStep {
    beforeBack?(): Promise<boolean>;
    beforeCancel?(): Promise<boolean>;
    onCurrentStep?(details: WizardStepChange): void;
}

Index

Methods

beforeBack? beforeCancel? onCurrentStep?

Methods

`Optional`beforeBack

beforeBack(): Promise<boolean>
A callback that runs before the wizard moves back a step from this current step.

Returns Promise<boolean>
A promise that resolves to a boolean indicating whether the wizard should move back a step.

`Optional`beforeCancel

beforeCancel(): Promise<boolean>
A callback that runs before the wizard cancels with this current step.

Returns Promise<boolean>
A promise that resolves to a boolean indicating whether the wizard should cancel.

`Optional`onCurrentStep

onCurrentStep(details): void
A callback that runs when this step is the current step.
Parameters
- details: WizardStepChange
  The step change details.
Returns void