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

    Interface NavigationMenuController

    Headless responsive Navigation Menu controller.

    interface NavigationMenuController {
        bind(elements: OverlayElements): () => void;
        close(details?: ChangeDetails<NavigationMenuReason>): void;
        destroy(): void;
        getSnapshot(): Readonly<TSnapshot>;
        handleKeyDown(event: KeyboardEvent): void;
        handleKeyDown(itemId: string, event: KeyboardEvent): void;
        off<TKey extends keyof NavigationMenuEvents>(
            type: TKey,
            listener: RuntimeEventListener<NavigationMenuEvents[TKey]>,
        ): void;
        on<TKey extends keyof NavigationMenuEvents>(
            type: TKey,
            listener: RuntimeEventListener<NavigationMenuEvents[TKey]>,
        ): Unsubscribe;
        once<TKey extends keyof NavigationMenuEvents>(
            type: TKey,
            listener: RuntimeEventListener<NavigationMenuEvents[TKey]>,
        ): Unsubscribe;
        openItem(id: string, details?: ChangeDetails<NavigationMenuReason>): void;
        registerItem(item: NavigationMenuItem, element?: HTMLElement): () => void;
        scheduleClose(event?: PointerEvent): void;
        scheduleOpen(id: string, event?: PointerEvent): void;
        setMode(mode: NavigationMenuMode): void;
        subscribe(listener: SnapshotListener<NavigationMenuSnapshot>): Unsubscribe;
    }

    Hierarchy (View Summary)

    Index

    Methods

    bind close destroy getSnapshot handleKeyDown off on once openItem registerItem scheduleClose scheduleOpen setMode subscribe

    Methods

    • Handles navigation and Escape, inferring the item from a registered event current target.

      Parameters

      • event: KeyboardEvent

      Returns void

    • Handles navigation and opening for an explicitly identified registered item.

      Parameters

      • itemId: string
      • event: KeyboardEvent

      Returns void

    • Schedules desktop pointer closing; compact mode closes immediately.

      Parameters

      • Optionalevent: PointerEvent

      Returns void

    • Schedules desktop pointer opening; compact mode opens immediately.

      Parameters

      • id: string
      • Optionalevent: PointerEvent

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods