@kumiki/machines/menu · API

interface Interfaces 3

interface menu/index.ts · L62

# CreateMenuInput

Members

defaultOpen?: optional defaultOpen?: boolean
items: items: readonly MenuItem[]
navigation?: optional navigation?: "wrap" | "clamp"
Default 'wrap' — APG menus wrap by default.

interface menu/index.ts · L46

# MenuContext

Members

activatedId: activatedId: string | null
Last activated item id. Bumped on ACTIVATE; the controller observes this and fires the consumer's onSelect callback. Cleared on CLOSE.
highlightedId: highlightedId: string | null
items: items: readonly MenuItem[]
typeahead: typeahead: string
Type-ahead buffer. Layer 3 resets via TYPEAHEAD.RESET after a quiet ms.

interface menu/index.ts · L27

# MenuItem

Members

disabled?: readonly optional disabled?: boolean
###### Overrides

CollectionItem.disabled
id: readonly id: string
###### Overrides

CollectionItem.id
kind?: readonly optional kind?: MenuItemKind
label?: readonly optional label?: string
###### Overrides

CollectionItem.label

type Type Aliases 4

type menu/index.ts · L34

# MenuEvent

MenuEvent = { type: "OPEN"; } | { type: "CLOSE"; } | { type: "TOGGLE"; } | { type: "ESCAPE"; } | { id: string; type: "ACTIVATE"; } | { id: string | null; type: "HIGHLIGHT"; } | { direction: NavigateDirection; type: "NAVIGATE"; } | { char: string; type: "TYPEAHEAD"; } | { type: "TYPEAHEAD.RESET"; } | { items: ReadonlyArray<MenuItem>; type: "SET.ITEMS"; }

type menu/index.ts · L25

# MenuItemKind

MenuItemKind = "item" | "separator"

type menu/index.ts · L60

# MenuMachine

MenuMachine = Machine<MenuContext, MenuEvent, MenuState>

type menu/index.ts · L58

# MenuState

MenuState = "closed" | "open"

function Functions 2

function menu/index.ts · L100

# createMenuMachine ( )

createMenuMachine(input): MenuMachine

Construct a fresh Menu machine.

Parameters

input: CreateMenuInput

Returns

MenuMachine

function menu/index.ts · L73

# lastEnabledId ( )

lastEnabledId(items): string | null

Parameters

items: readonly MenuItem[]

Returns

string | null