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

    Interface StatusBarData

    Stateful data accepted by the Blessed statusBar adapter.

    interface StatusBarData {
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        foregroundTone?: keyof ThemeColors;
        theme?: Theme;
        capabilities?: Pick<TerminalCapabilities, "unicode" | "colorLevel">;
        characters?: StatusBarCharacters;
        width?: number;
        message?: string;
        items?: readonly StatusBarItem[];
        pad?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    backgroundTone? borderTone? foregroundTone? theme? capabilities? characters? width? message? items? pad?

    Properties

    backgroundTone?: keyof ThemeColors

    Semantic background token.

    'background'

    borderTone?: keyof ThemeColors

    Semantic border token.

    'border'

    foregroundTone?: keyof ThemeColors

    Semantic foreground token.

    'foreground'

    theme?: Theme

    Semantic terminal theme.

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

    Explicit terminal capabilities used for deterministic rendering.

    characters?: StatusBarCharacters

    Custom StatusBar separators.

    width?: number

    Explicit render width. Defaults to the current Blessed element width.

    message?: string

    Optional one-line message. When present, it is rendered after left items.

    items?: readonly StatusBarItem[]

    Status items grouped into left, center, and right sections.

    pad?: boolean

    Whether the output is padded to exactly width cells.

    true

    Settings

    Member Visibility

    On This Page

    Properties