blessed-components - v1.25.0
    Preparing search index...

    Interface CreateWizardStateOptions

    Options accepted by createWizardState.

    interface CreateWizardStateOptions {
        defaultStepId?: string;
        onCancel?: (step: WizardStep) => void;
        onComplete?: (step: WizardStep) => void;
        onStepChange?: (stepId: string, previousStepId: string) => void;
        steps: readonly WizardStep[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    defaultStepId? onCancel? onComplete? onStepChange? steps

    Properties

    defaultStepId?: string

    Initial step id. Defaults to the first step.

    onCancel?: (step: WizardStep) => void

    Called once when the flow is cancelled.

    onComplete?: (step: WizardStep) => void

    Called once when the final step completes.

    onStepChange?: (stepId: string, previousStepId: string) => void

    Called after active-step changes.

    steps: readonly WizardStep[]

    Ordered, non-empty Wizard pages.

    Settings

    Member Visibility

    On This Page

    Properties