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

    Interface TagData

    Stateful data accepted by the Blessed tag adapter.

    interface TagData {
        capabilities?: Pick<TerminalCapabilities, "colorLevel">;
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        theme?: Theme;
        tone?: keyof ThemeColors;
        delimiters?: TagDelimiters;
        prefix?: string;
        removable?: boolean;
        removeMarker?: string;
        text: string;
        variant?: TagVariant;
        align?: TextAlign;
        height?: number;
        omission?: string;
        overflow?: TextOverflow;
        truncatePosition?: "end" | "middle" | "start";
        verticalAlign?: TextVerticalAlign;
        width?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    capabilities? backgroundTone? borderTone? theme? tone? delimiters? prefix? removable? removeMarker? text variant? align? height? omission? overflow? truncatePosition? verticalAlign? 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.

    'primary'

    delimiters?: TagDelimiters

    Delimiters used by the bracketed variant.

    Both values must be non-empty.

    { open: '[', close: ']' }

    prefix?: string

    Prefix used by the hash variant.

    '#'

    removable?: boolean

    Whether the tag includes a remove affordance marker.

    false

    removeMarker?: string

    Marker appended when removable is enabled.

    '×'

    text

    text: string

    Non-empty tag label. ANSI sequences and Blessed tags are removed.

    variant?: TagVariant

    Tag structure.

    'hash'

    align?: TextAlign

    Horizontal alignment applied after overflow handling.

    'left'

    height?: number

    Maximum rendered line count.

    omission?: string

    Omission marker used by truncate overflow.

    '…'

    overflow?: TextOverflow

    Horizontal overflow policy.

    'wrap'

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

    Truncation position used by truncate overflow.

    'end'

    verticalAlign?: TextVerticalAlign

    Vertical alignment applied when both height and width are configured.

    'top'

    width?: number

    Maximum rendered width measured in terminal cells.

    Settings

    Member Visibility

    On This Page

    Properties