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

    Interface RenderTextOptions

    Options accepted by renderText.

    interface RenderTextOptions {
        align?: TextAlign;
        content: string;
        height?: number;
        omission?: string;
        overflow?: TextOverflow;
        truncatePosition?: "end" | "middle" | "start";
        verticalAlign?: TextVerticalAlign;
        width?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    align? content height? omission? overflow? truncatePosition? verticalAlign? width?

    Properties

    align?: TextAlign

    Horizontal alignment applied after overflow handling.

    'left'

    content

    content: string

    Dynamic terminal text. ANSI sequences and Blessed tags are removed.

    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