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

    Interface HeadingData

    Stateful data accepted by the Blessed heading adapter.

    interface HeadingData {
        capabilities?: Pick<TerminalCapabilities, "colorLevel">;
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        theme?: Theme;
        bold?: boolean;
        tone?: keyof ThemeColors;
        content: string;
        align?: TextAlign;
        level?: HeadingLevel;
        marker?: boolean;
        overflow?: TextOverflow;
        underline?: boolean;
        underlineCharacter?: string;
        omission?: string;
        truncatePosition?: "end" | "middle" | "start";
        width?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    capabilities? backgroundTone? borderTone? theme? bold? tone? content align? level? marker? overflow? underline? underlineCharacter? 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.

    bold?: boolean

    Whether Blessed should draw the heading in bold. Defaults to true for levels 1 and 2.

    tone?: keyof ThemeColors

    Semantic foreground token.

    'foreground'

    content

    content: string

    Heading text. ANSI sequences and Blessed tags are removed.

    align?: TextAlign

    Horizontal alignment applied after overflow handling.

    'left'

    level?: HeadingLevel

    Semantic heading depth.

    1

    marker?: boolean

    Prefix the heading with Markdown-style level markers.

    true

    overflow?: TextOverflow

    Horizontal overflow policy.

    'truncate'

    underline?: boolean

    Add an underline sized to the rendered heading line.

    false

    underlineCharacter?: string

    Character used for the underline.

    '-'

    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