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

    Interface CalculateAppShellLayoutOptions

    Options accepted by calculateAppShellLayout.

    interface CalculateAppShellLayoutOptions {
        footerHeight?: number;
        gap?: number;
        headerHeight?: number;
        height: number;
        minContentWidth?: number;
        sidebarCollapsed?: boolean;
        sidebarCollapseBelow?: number;
        sidebarWidth?: number;
        width: number;
    }
    Index

    Properties

    footerHeight? gap? headerHeight? height minContentWidth? sidebarCollapsed? sidebarCollapseBelow? sidebarWidth? width

    Properties

    footerHeight?: number

    Footer height in terminal rows.

    0

    gap?: number

    Empty rows or cells between adjacent regions.

    0

    headerHeight?: number

    Header height in terminal rows.

    1

    height: number

    Total available shell height in terminal rows.

    minContentWidth?: number

    Minimum useful content width before sidebar auto-collapse.

    1

    sidebarCollapsed?: boolean

    Explicitly hide the sidebar.

    sidebarCollapseBelow?: number

    Hide sidebar when total shell width is below this threshold.

    sidebarWidth?: number

    Preferred sidebar width in terminal cells.

    24

    width: number

    Total available shell width in terminal cells.

    Settings

    Member Visibility

    On This Page

    Properties