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

    Interface HeaderBarData<TAction>

    Shared semantic style data accepted by themed Blessed adapters.

    interface HeaderBarData<TAction extends HeaderBarAction = HeaderBarAction> {
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        foregroundTone?: keyof ThemeColors;
        theme?: Theme;
        activeActionId?: string;
        capabilities?: Pick<TerminalCapabilities, "unicode" | "colorLevel">;
        onAction?: (action: TAction) => void;
        onActiveActionIdChange?: (id: string) => void;
        width?: number;
        actions?: readonly TAction[];
        environment?: string;
        pad?: boolean;
        status?: HeaderBarStatus;
        title: string;
        workspace?: string;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    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.

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

    Explicit color capability used for deterministic rendering.

    onAction?: (action: TAction) => void
    onActiveActionIdChange?: (id: string) => void
    width?: number
    actions?: readonly TAction[]
    environment?: string
    pad?: boolean
    title: string
    workspace?: string