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

    Interface StepperFormData

    Stateful data accepted by the Blessed stepperForm adapter.

    interface StepperFormData {
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        foregroundTone?: keyof ThemeColors;
        theme?: Theme;
        capabilities?: Pick<TerminalCapabilities, "unicode" | "colorLevel">;
        labels?: { back?: string; complete?: string; next?: string };
        defaultStepId?: string;
        getValues: () => FormValues;
        onComplete?: (values: FormValues) => void;
        onInvalid?: (stepId: string, errors: FormErrors) => void;
        onStepChange?: (stepId: string, previousStepId: string) => void;
        steps: readonly StepperFormStep[];
        validate?: (fieldIds: readonly string[], values: FormValues) => FormErrors;
    }

    Hierarchy (View Summary)

    Index

    Properties

    backgroundTone? borderTone? foregroundTone? theme? capabilities? labels? defaultStepId? getValues onComplete? onInvalid? onStepChange? steps validate?

    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">

    Explicit color capability used for deterministic rendering.

    labels?: { back?: string; complete?: string; next?: string }

    Labels shown in the navigation footer.

    defaultStepId?: string

    Initial step id for uncontrolled state.

    getValues: () => FormValues

    Returns current form values.

    onComplete?: (values: FormValues) => void

    Called after the final step passes validation.

    onInvalid?: (stepId: string, errors: FormErrors) => void

    Called when a navigation request is blocked by validation.

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

    Called after the active step changes.

    steps: readonly StepperFormStep[]

    Ordered, non-empty steps.

    validate?: (fieldIds: readonly string[], values: FormValues) => FormErrors

    Validates registered fields and returns errors keyed by field id.

    Settings

    Member Visibility

    On This Page

    Properties