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

    Interface DialogRootHandle

    Imperative handle returned by dialogRoot.

    interface DialogRootHandle {
        isOpen: boolean;
        close(): boolean;
        open(): boolean;
        registerFocusable(id: string, element: BlessedElement): void;
        toggle(): boolean;
        unregisterFocusable(id: string): void;
        element: BoxElement;
        destroy(): void;
        setData(data: DialogRootData): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    isOpen: boolean

    Current controlled or uncontrolled open state.

    element: BoxElement

    Underlying Blessed element available for standard element operations.

    Methods

    • Registers one focusable element in Tab order.

      Parameters

      • id: string
      • element: BlessedElement

      Returns void

    • Removes one element from managed Tab order.

      Parameters

      • id: string

      Returns void