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

    Interface WizardHandle

    Imperative handle returned by wizard.

    interface WizardHandle {
        element: BoxElement;
        destroy(): void;
        setData(data: WizardData): void;
        focus(): void;
        activeIndex(): number;
        activeStep(): WizardStep;
        cancel(): WizardActionResult;
        complete(): WizardActionResult;
        goTo(stepId: string): WizardActionResult;
        hasPrevious(): boolean;
        isLast(): boolean;
        next(): WizardActionResult;
        previous(): WizardActionResult;
        reset(): WizardActionResult;
        status(): WizardStatus;
    }

    Hierarchy (View Summary)

    • BlessedComponentHandle<WizardData, blessed.Widgets.BoxElement>
    • Pick<
          WizardStateModel,
          | "activeIndex"
          | "activeStep"
          | "cancel"
          | "complete"
          | "goTo"
          | "hasPrevious"
          | "isLast"
          | "next"
          | "previous"
          | "reset"
          | "status",
      >
      • WizardHandle
    Index

    Properties

    element: BoxElement

    Underlying Blessed element available for standard element operations.

    Methods