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

    Interface LegendData

    Stateful data accepted by the Blessed legend adapter.

    interface LegendData {
        capabilities?: Pick<TerminalCapabilities, "colorLevel">;
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        theme?: Theme;
        tone?: keyof ThemeColors;
        emptyText?: string;
        layout?: LegendLayout;
        items: readonly LegendItem[];
        separator?: string;
        width?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    capabilities? backgroundTone? borderTone? theme? tone? emptyText? layout? items separator? width?

    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'

    emptyText?: string

    Text rendered when items is empty.

    'No legend items'

    layout?: LegendLayout

    Arrangement of legend entries.

    'horizontal'

    items: readonly LegendItem[]

    Ordered legend items.

    separator?: string

    Separator between horizontally rendered entries.

    ' '

    width?: number

    Optional maximum width of each rendered line.

    Settings

    Member Visibility

    On This Page

    Properties