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

    Interface StepIndicatorData

    Stateful data accepted by the Blessed stepIndicator adapter.

    interface StepIndicatorData {
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        theme?: Theme;
        capabilities?: Pick<TerminalCapabilities, "unicode" | "colorLevel">;
        markers?: StepIndicatorMarkers;
        tone?: keyof ThemeColors;
        detailSeparator?: string;
        height?: number;
        orientation?: "horizontal" | "vertical";
        separator?: string;
        showDetail?: boolean;
        steps: readonly StepIndicatorStep[];
        width?: number;
    }

    Hierarchy

    Index

    Properties

    backgroundTone? borderTone? theme? capabilities? markers? tone? detailSeparator? height? orientation? separator? showDetail? steps width?

    Properties

    backgroundTone?: keyof ThemeColors

    Semantic background token.

    'background'

    borderTone?: keyof ThemeColors

    Semantic border token.

    'border'

    theme?: Theme

    Semantic terminal theme.

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

    Explicit terminal capabilities used for deterministic rendering.

    markers?: StepIndicatorMarkers

    Custom state markers.

    tone?: keyof ThemeColors

    Semantic foreground token.

    'foreground'

    detailSeparator?: string

    Separator between label and detail.

    ' - '

    height?: number

    Maximum rendered line count.

    orientation?: "horizontal" | "vertical"

    Layout orientation.

    'vertical'

    separator?: string

    Separator between horizontal steps.

    ' '

    showDetail?: boolean

    Whether detail text is rendered in vertical mode.

    true

    steps: readonly StepIndicatorStep[]

    Ordered steps to render.

    width?: number

    Maximum rendered width measured in terminal cells.

    Settings

    Member Visibility

    On This Page

    Properties