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

    Interface WizardData

    Stateful data accepted by the Blessed wizard adapter.

    interface WizardData {
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        foregroundTone?: keyof ThemeColors;
        theme?: Theme;
        capabilities?: Pick<TerminalCapabilities, "unicode" | "colorLevel">;
        dismissOnEscape?: boolean;
        id: string;
        labels?: WizardLabels;
        defaultStepId?: string;
        onCancel?: (step: WizardStep) => void;
        onComplete?: (step: WizardStep) => void;
        onStepChange?: (stepId: string, previousStepId: string) => void;
        steps: readonly WizardStep[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    backgroundTone? borderTone? foregroundTone? theme? capabilities? dismissOnEscape? id labels? defaultStepId? onCancel? onComplete? onStepChange? steps

    Properties

    backgroundTone?: keyof ThemeColors

    Semantic background token.

    'background'

    borderTone?: keyof ThemeColors

    Semantic border token.

    'border'

    foregroundTone?: keyof ThemeColors

    Semantic foreground token.

    'foreground'

    theme?: Theme

    Semantic terminal theme.

    capabilities?: Pick<TerminalCapabilities, "unicode" | "colorLevel">

    Terminal capabilities used for progress markers and theme colors.

    dismissOnEscape?: boolean

    Whether Escape dismisses a modal Wizard.

    true

    id: string

    Stable identity used by modal overlay stacking.

    labels?: WizardLabels

    Labels shown in the navigation footer.

    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