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

    Interface CollapsibleHandle

    Imperative handle returned by collapsible.

    interface CollapsibleHandle {
        body: BoxElement;
        expanded(): boolean;
        focus(): void;
        header: BoxElement;
        setExpanded(expanded: boolean): boolean;
        toggle(): boolean;
        element: BoxElement;
        destroy(): void;
        setData(data: CollapsibleData): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    body: BoxElement

    Body element where callers can append child widgets that survive collapse.

    header: BoxElement

    Header element that receives keyboard and mouse toggle interaction.

    element: BoxElement

    Underlying Blessed element available for standard element operations.

    Methods

    • Sets an enabled expanded state and reports whether setting occurred.

      Parameters

      • expanded: boolean

      Returns boolean