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

    Interface RenderBreadcrumbOptions

    Options accepted by renderBreadcrumb.

    interface RenderBreadcrumbOptions {
        collapse?: boolean;
        items: readonly BreadcrumbItem[];
        separator?: string;
        align?: TextAlign;
        height?: number;
        omission?: string;
        overflow?: TextOverflow;
        truncatePosition?: "end" | "middle" | "start";
        verticalAlign?: TextVerticalAlign;
        width?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    collapse? items separator? align? height? omission? overflow? truncatePosition? verticalAlign? width?

    Properties

    collapse?: boolean

    Whether to collapse middle segments to the omission marker when width is constrained.

    true

    items: readonly BreadcrumbItem[]

    Ordered path segments.

    separator?: string

    Text inserted between path segments.

    ' / '

    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