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

    Interface KeyValueData

    Stateful data accepted by the Blessed keyValue adapter.

    interface KeyValueData {
        capabilities?: Pick<TerminalCapabilities, "colorLevel">;
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        theme?: Theme;
        tone?: keyof ThemeColors;
        gap?: number;
        items: readonly KeyValueItem[];
        itemSeparator?: string;
        keyWidth?: number | "auto";
        layout?: KeyValueLayout;
        separator?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    capabilities? backgroundTone? borderTone? theme? tone? gap? items itemSeparator? keyWidth? layout? separator?

    Properties

    capabilities?: Pick<TerminalCapabilities, "colorLevel">

    Explicit color capability used for deterministic rendering.

    backgroundTone?: keyof ThemeColors

    Semantic background token.

    'background'

    borderTone?: keyof ThemeColors

    Semantic border token.

    'border'

    theme?: Theme

    Semantic terminal theme.

    tone?: keyof ThemeColors

    Semantic foreground token.

    'foreground'

    gap?: number

    Spaces around a non-empty separator. When the separator is empty, the gap is inserted once between key and value.

    1

    items: readonly KeyValueItem[]

    Ordered key/value entries.

    itemSeparator?: string

    Text inserted between entries in the inline layout.

    ' · '

    keyWidth?: number | "auto"

    Width reserved for every key in terminal cells.

    auto uses the widest key. A numeric width truncates longer keys.

    'auto'

    layout?: KeyValueLayout

    Entry arrangement.

    'rows'

    separator?: string

    Text between each key and value. Use an empty string for whitespace-only separation.

    ':'

    Settings

    Member Visibility

    On This Page

    Properties