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

    Interface StatusData

    Stateful data accepted by the Blessed status adapter.

    interface StatusData {
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        theme?: Theme;
        capabilities?: Pick<TerminalCapabilities, "unicode" | "colorLevel">;
        markers?: StatusMarkers;
        foregroundTone?: keyof ThemeColors;
        detail?: string;
        detailSeparator?: string;
        label: string;
        marker?: string;
        showMarker?: boolean;
        tone?: StatusTone;
    }

    Hierarchy

    Index

    Properties

    backgroundTone? borderTone? theme? capabilities? markers? foregroundTone? detail? detailSeparator? label marker? showMarker? tone?

    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?: StatusMarkers

    Custom ordered semantic markers.

    foregroundTone?: keyof ThemeColors

    Semantic foreground token. Defaults to the status tone.

    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.

    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