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

    Interface RenderStepIndicatorOptions

    Options accepted by renderStepIndicator.

    interface RenderStepIndicatorOptions {
        detailSeparator?: string;
        height?: number;
        markers?: StepIndicatorMarkers;
        orientation?: "horizontal" | "vertical";
        separator?: string;
        showDetail?: boolean;
        steps: readonly StepIndicatorStep[];
        width?: number;
    }
    Index

    Properties

    detailSeparator? height? markers? orientation? separator? showDetail? steps width?

    Properties

    detailSeparator?: string

    Separator between label and detail.

    ' - '

    height?: number

    Maximum rendered line count.

    markers?: StepIndicatorMarkers

    Step marker mapping.

    Every marker must be exactly one terminal cell wide.

    STEP_INDICATOR_UNICODE_MARKERS

    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