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

    Interface DrawerRegionData

    Stateful content and theme data shared by Drawer visual regions.

    interface DrawerRegionData {
        capabilities?: Pick<TerminalCapabilities, "colorLevel">;
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        theme?: Theme;
        tone?: keyof ThemeColors;
        align?: TextAlign;
        height?: number;
        omission?: string;
        overflow?: TextOverflow;
        truncatePosition?: "end" | "middle" | "start";
        verticalAlign?: TextVerticalAlign;
        width?: number;
        content?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    capabilities? backgroundTone? borderTone? theme? tone? align? height? omission? overflow? truncatePosition? verticalAlign? width? content?

    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.

    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.

    Optionalcontent

    content?: string

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

    Settings

    Member Visibility

    On This Page

    Properties