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

    Interface AppShellHandle

    Imperative handle returned by appShell.

    interface AppShellHandle {
        collapsed(): boolean;
        content: BoxElement;
        footer: BoxElement;
        header: BoxElement;
        layout(): void;
        overlay: BoxElement;
        setCollapsed(collapsed: boolean): boolean;
        sidebar: BoxElement;
        toggleSidebar(): boolean;
        element: BoxElement;
        destroy(): void;
        setData(data: AppShellData): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    content: BoxElement

    Main content region.

    footer: BoxElement

    Footer region.

    header: BoxElement

    Header region.

    overlay: BoxElement

    Overlay layer.

    sidebar: BoxElement

    Sidebar region.

    element: BoxElement

    Underlying Blessed element available for standard element operations.

    Methods

    • Sets sidebar collapsed state and reports whether setting occurred.

      Parameters

      • collapsed: boolean

      Returns boolean