UI Headless Runtime API - v1.0.0
    Preparing search index...

    Interface TooltipController

    Headless non-interactive Tooltip controller.

    interface TooltipController {
        bind(trigger: HTMLElement, content: HTMLElement): () => void;
        close(details?: ChangeDetails<OpenChangeReason>): void;
        destroy(): void;
        getSnapshot(): Readonly<TSnapshot>;
        off<TKey extends keyof OpenLifecycleEvents<OpenChangeReason>>(
            type: TKey,
            listener: RuntimeEventListener<
                OpenLifecycleEvents<OpenChangeReason>[TKey],
            >,
        ): void;
        on<TKey extends keyof OpenLifecycleEvents<OpenChangeReason>>(
            type: TKey,
            listener: RuntimeEventListener<
                OpenLifecycleEvents<OpenChangeReason>[TKey],
            >,
        ): Unsubscribe;
        once<TKey extends keyof OpenLifecycleEvents<OpenChangeReason>>(
            type: TKey,
            listener: RuntimeEventListener<
                OpenLifecycleEvents<OpenChangeReason>[TKey],
            >,
        ): Unsubscribe;
        scheduleClose(reason?: "focus-out" | "hover", event?: Event): void;
        scheduleOpen(reason?: "focus" | "hover", event?: Event): void;
        subscribe(listener: SnapshotListener<TooltipSnapshot>): Unsubscribe;
    }

    Hierarchy (View Summary)

    Index

    Methods

    bind close destroy getSnapshot off on once scheduleClose scheduleOpen subscribe

    Methods

    • Binds trigger/content listeners and positioning; touch pointer entry is intentionally ignored.

      Parameters

      • trigger: HTMLElement
      • content: HTMLElement

      Returns () => void

    • Closes after the configured pointer delay, or immediately for focus exit.

      Parameters

      • Optionalreason: "focus-out" | "hover"
      • Optionalevent: Event

      Returns void

    • Opens after the configured pointer delay, or immediately for keyboard focus.

      Parameters

      • Optionalreason: "focus" | "hover"
      • Optionalevent: Event

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods