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

    Interface SidebarLayoutHandle

    Imperative handle returned by sidebarLayout.

    interface SidebarLayoutHandle {
        collapsed(): boolean;
        layout(): void;
        main: BoxElement;
        setCollapsed(collapsed: boolean): boolean;
        sidebar: BoxElement;
        toggle(): boolean;
        element: BoxElement;
        destroy(): void;
        setData(data: SidebarLayoutData): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    main: BoxElement

    Main content region where callers can append child widgets.

    sidebar: BoxElement

    Sidebar region where callers can append child widgets.

    element: BoxElement

    Underlying Blessed element available for standard element operations.

    Methods

    • Sets collapsed state and reports whether setting occurred.

      Parameters

      • collapsed: boolean

      Returns boolean