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

    Interface DropdownMenuController

    Dropdown Menu controller with trigger-specific activation.

    interface DropdownMenuController {
        bind(elements: OverlayElements): () => void;
        close(details?: ChangeDetails<OpenChangeReason>): void;
        destroy(): void;
        getSnapshot(): Readonly<TSnapshot>;
        handleKeyDown(event: KeyboardEvent): void;
        handleTrigger(event: KeyboardEvent | MouseEvent): void;
        off<TKey extends keyof MenuEvents>(
            type: TKey,
            listener: RuntimeEventListener<MenuEvents[TKey]>,
        ): void;
        on<TKey extends keyof MenuEvents>(
            type: TKey,
            listener: RuntimeEventListener<MenuEvents[TKey]>,
        ): Unsubscribe;
        once<TKey extends keyof MenuEvents>(
            type: TKey,
            listener: RuntimeEventListener<MenuEvents[TKey]>,
        ): Unsubscribe;
        open(details?: ChangeDetails<OpenChangeReason>): void;
        registerItem(item: MenuItem, element?: HTMLElement): () => void;
        registerSubmenu(itemId: string, submenu: MenuController): () => void;
        select(id: string, details?: ChangeDetails<MenuSelectReason>): void;
        setActive(id: string | null): void;
        subscribe(listener: SnapshotListener<MenuSnapshot>): Unsubscribe;
        toggle(details?: ChangeDetails<OpenChangeReason>): void;
    }

    Hierarchy (View Summary)

    Index

    Methods

    bind close destroy getSnapshot handleKeyDown handleTrigger off on once open registerItem registerSubmenu select setActive subscribe toggle

    Methods

    • Opens on pointer click or ArrowDown/Enter/Space keyboard activation.

      Parameters

      • event: KeyboardEvent | MouseEvent

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods