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

    Interface WizardStep

    A page in a guided Wizard flow.

    interface WizardStep {
        canAdvance?: (context: WizardGuardContext) => string | boolean;
        content?: string | readonly string[];
        description?: string;
        id: string;
        label: string;
        title?: string;
    }
    Index

    Properties

    canAdvance? content? description? id label title?

    Properties

    canAdvance?: (context: WizardGuardContext) => string | boolean

    Returns false or an explanatory message to block forward navigation.

    Optionalcontent

    content?: string | readonly string[]

    Body content rendered for this step.

    description?: string

    Optional supporting text rendered below the title.

    id: string

    Stable step identifier.

    label: string

    Short label used by the progress indicator.

    title?: string

    Page heading. Defaults to label.

    Settings

    Member Visibility

    On This Page

    Properties