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

    Interface RenderStatusOptions

    Options accepted by renderStatus.

    interface RenderStatusOptions {
        detail?: string;
        detailSeparator?: string;
        label: string;
        marker?: string;
        markers?: StatusMarkers;
        showMarker?: boolean;
        tone?: StatusTone;
    }
    Index

    Properties

    detail? detailSeparator? label marker? markers? showMarker? tone?

    Properties

    detail?: string

    Optional secondary text rendered after the label.

    Empty sanitized details are omitted.

    detailSeparator?: string

    Separator inserted between label and detail.

    ' - '

    label: string

    Non-empty primary status text.

    marker?: string

    Explicit marker rendered before the label.

    markers?: StatusMarkers

    Semantic marker mapping.

    Every marker must be exactly one terminal cell wide.

    STATUS_UNICODE_MARKERS

    showMarker?: boolean

    Whether the semantic marker is rendered.

    true

    tone?: StatusTone

    Semantic status used to select a marker.

    'neutral'

    Settings

    Member Visibility

    On This Page

    Properties