Quartz Headless docs/MenuService

Search documentation

Type to search the documentation.

API: Primitives

MenuService

Service reference for MenuService.

Overview

Properties

Name Type Description
readonly items Signal<MenuCollectionEntry[]>
readonly activeId Signal<string>
readonly activeItem Signal<MenuCollectionEntry>
readonly openSubmenuId Signal<string | null>
readonly isRoot boolean
readonly root MenuService
readonly config Signal<MenuConfig>

Public methods

configure

configure(config: Partial<MenuConfig>): void
Parameter Type Optional Description
config Partial<MenuConfig>

register

register(item: MenuCollectionEntry): void
Parameter Type Optional Description
item MenuCollectionEntry

unregister

unregister(item: MenuCollectionEntry): void
Parameter Type Optional Description
item MenuCollectionEntry

setActive

setActive(id: string | null, options?: { focus?: boolean; }): void
Parameter Type Optional Description
id string | null
options { focus?: boolean } Yes

activeTabIndex

activeTabIndex(id: string): 0 | -1
Parameter Type Optional Description
id string

focusFirst

focusFirst(): void

focusLast

focusLast(): void

focusActive

focusActive(): void

handleKeydown

handleKeydown(event: KeyboardEvent, host: HTMLElement): void
Parameter Type Optional Description
event KeyboardEvent
host HTMLElement

requestOpenSubmenu

requestOpenSubmenu(ownerId: string, open: () => void, close: () => void): void
Parameter Type Optional Description
ownerId string
open () => void
close () => void

closeOpenSubmenu

closeOpenSubmenu(): void

registerPanel

registerPanel(el: HTMLElement): void
Parameter Type Optional Description
el HTMLElement

unregisterPanel

unregisterPanel(el: HTMLElement): void
Parameter Type Optional Description
el HTMLElement

registerRootClose

registerRootClose(fn: (restoreFocus: boolean) => void): void
Parameter Type Optional Description
fn (restoreFocus: boolean) => void

unregisterRootClose

unregisterRootClose(fn: (restoreFocus: boolean) => void): void
Parameter Type Optional Description
fn (restoreFocus: boolean) => void

registerLevelClose

registerLevelClose(fn: (restoreFocus: boolean) => void): void
Parameter Type Optional Description
fn (restoreFocus: boolean) => void

unregisterLevelClose

unregisterLevelClose(fn: (restoreFocus: boolean) => void): void
Parameter Type Optional Description
fn (restoreFocus: boolean) => void

closeAll

closeAll(restoreFocus?: boolean): void
Parameter Type Optional Description
restoreFocus boolean Yes

destroy

destroy(): void