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

    Interface RenderHeadingOptions

    Options accepted by renderHeading.

    interface RenderHeadingOptions {
        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

    content align? level? marker? overflow? underline? underlineCharacter? omission? truncatePosition? width?

    Properties

    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