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

    Interface ConnectionStatusData

    Stateful data accepted by the Blessed connectionStatus adapter.

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

    Hierarchy

    Index

    Properties

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

    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.

    foregroundTone?: keyof ThemeColors

    Semantic foreground token. Defaults to the connection state tone.

    markers?: StatusMarkers

    Custom semantic markers.

    detail?: string

    Additional detail rendered after latency, when present.

    state?: ConnectionState

    Current connection state.

    'online'

    latency?: number

    Optional latency in milliseconds.

    Must be a non-negative finite number.

    label?: string

    Explicit primary label. Defaults to a label derived from state.

    detailSeparator?: string

    Separator inserted between label and detail.

    ' - '

    marker?: string

    Explicit marker rendered before the label.

    showMarker?: boolean

    Whether the semantic marker is rendered.

    true

    Settings

    Member Visibility

    On This Page

    Properties