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

    Interface LabelData

    Stateful data accepted by the Blessed label adapter.

    interface LabelData {
        capabilities?: Pick<TerminalCapabilities, "colorLevel">;
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        theme?: Theme;
        tone?: keyof ThemeColors;
        content: string;
        align?: TextAlign;
        indicatorGap?: number;
        overflow?: LabelOverflow;
        required?: boolean;
        requiredIndicator?: string;
        suffix?: string;
        omission?: string;
        truncatePosition?: "end" | "middle" | "start";
        width?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    capabilities? backgroundTone? borderTone? theme? tone? content align? indicatorGap? overflow? required? requiredIndicator? suffix? omission? truncatePosition? 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.

    'muted'

    content

    content: string

    Label text. ANSI sequences and Blessed tags are removed.

    align?: TextAlign

    Horizontal alignment applied after overflow handling.

    'left'

    indicatorGap?: number

    Spaces inserted between the label text and required indicator.

    1

    overflow?: LabelOverflow

    Single-line overflow policy.

    'truncate'

    required?: boolean

    Whether to append a required indicator.

    false

    requiredIndicator?: string

    Marker appended when required is true.

    '*'

    suffix?: string

    Stable suffix after the label and optional required indicator.

    ':'

    omission?: string

    Omission marker used by truncate overflow.

    '…'

    truncatePosition?: "end" | "middle" | "start"

    Truncation position used by truncate overflow.

    'end'

    width?: number

    Maximum rendered width measured in terminal cells.

    Settings

    Member Visibility

    On This Page

    Properties