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

    Interface FooterBarData

    Shared semantic style data accepted by themed Blessed adapters.

    interface FooterBarData {
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        foregroundTone?: keyof ThemeColors;
        theme?: Theme;
        capabilities?: Pick<TerminalCapabilities, "unicode" | "colorLevel">;
        characters?: FooterBarCharacters;
        width?: number;
        context?: string;
        message?: string;
        pad?: boolean;
        shortcuts?: readonly FooterBarShortcut[];
        tone?: FooterBarTone;
    }

    Hierarchy (View Summary)

    Index

    Properties

    backgroundTone? borderTone? foregroundTone? theme? capabilities? characters? width? context? message? pad? shortcuts? tone?

    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 color capability used for deterministic rendering.

    characters?: FooterBarCharacters
    width?: number
    context?: string

    Persistent application context shown before the message.

    message?: string

    Current or transient application message.

    pad?: boolean

    Whether output is padded to exactly width.

    true

    shortcuts?: readonly FooterBarShortcut[]
    tone?: FooterBarTone

    Semantic marker for message.

    Settings

    Member Visibility

    On This Page

    Properties