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

    Interface CalculateSidebarLayoutOptions

    Options accepted by calculateSidebarLayout.

    interface CalculateSidebarLayoutOptions {
        collapsed?: boolean;
        collapseBelow?: number;
        gap?: number;
        height: number;
        minMainWidth?: number;
        sidebarWidth?: number;
        width: number;
    }
    Index

    Properties

    collapsed? collapseBelow? gap? height minMainWidth? sidebarWidth? width

    Properties

    collapsed?: boolean

    Explicitly hide the sidebar.

    collapseBelow?: number

    Hide sidebar when total width is below this threshold.

    gap?: number

    Empty cells between sidebar and main while sidebar is visible.

    0

    height: number

    Total available height in terminal rows.

    minMainWidth?: number

    Minimum useful main width before automatic collapse.

    1

    sidebarWidth?: number

    Preferred sidebar width in terminal cells.

    24

    width: number

    Total available width in terminal cells.

    Settings

    Member Visibility

    On This Page

    Properties