zidane-ui/keybindings

A footer legend entry: the keys, then what they do (↑ ↓ Navigate).

function FooterHint(props: FooterHintProps): Element

ui/src/keybindings/KeyHint.tsx:69

Provides a KeybindingsHost and optional label overrides to the keybindings hooks and components below it.

function KeybindingsProvider(props: KeybindingsProviderProps): Element

ui/src/keybindings/KeybindingsProvider.tsx:70

Holds a key command registry and fires its handlers on the document, against the bindings of the nearest KeybindingsProvider (the defaults without one). AppHostProvider mounts one.

function KeyCommandsProvider(props: KeyCommandsProviderProps): Element

ui/src/keybindings/KeyCommands.tsx:52

A key binding as keycaps: one .zg-keycap per key (⌘ K), macOS glyphs, alternatives quietly separated.

function KeyHint(props: KeyHintProps): Element

ui/src/keybindings/KeyHint.tsx:36

Listens on the document for the given actions' chords (the dispatcher's rules, see the header) and calls the handler read returns at press time. Returns the function that removes the listeners.

function bindKeyListeners(
  actions: readonly KeyAction[],
  merged: KeyBindings,
  read: (action: KeyAction) => (() => void) | undefined,
): () => void

ui/src/keybindings/KeybindingsProvider.tsx:169

Whether a key event fires a binding. All declared modifiers must be pressed and no others, so 'o' does not match ctrl+o and 'ctrl+o' does not match ctrl+shift+o. A spec with alternatives (ctrl+w | cmd+w) matches any.

function matchesBinding(event: KeyboardEvent, spec: string | ParsedBinding): boolean

ui/src/keybindings/match.ts:15

Whether this platform's mod is ⌘.

function modIsMeta(): boolean

ui/src/keybindings/press.ts:29

Presses chord where focus is. Returns whether a binding took it (a listener called preventDefault). A chord that doesn't parse presses nothing and returns false.

function pressChord(chord: string, options?: PressChordOptions): boolean

ui/src/keybindings/press.ts:61

A chord with mod resolved: cmd on macOS, ctrl elsewhere. Other parts stay as written.

function resolveChord(chord: string, mac?: boolean): string

ui/src/keybindings/press.ts:39

Calls onOpen on a bare ? outside fields. The listener attaches once; both callbacks are read at press time.

function useHelpKey(onOpen: (() => void) | undefined, blocked?: () => boolean): void

ui/src/keybindings/useHelpKey.ts:19

Listens on the document for the bound actions' keys and calls their handlers. Handlers are read at press time, so a fresh object each render costs nothing; only the set of bound actions decides what is listened for. The first action (in the caller's order) matching a chord wins.

function useKeybindings(handlers: KeybindingHandlers): void

ui/src/keybindings/KeybindingsProvider.tsx:120

The KeybindingsHost from the nearest KeybindingsProvider, or null outside one (the defaults apply).

function useKeybindingsHost(): KeybindingsHost | null

ui/src/keybindings/KeybindingsProvider.tsx:79

Returns the keybindings components' strings: the defaults merged with any overrides.

function useKeybindingsLabels(): { keyHintOr: string }

ui/src/keybindings/useKeybindingsLabels.ts:11

The bound actions of the nearest registry, as one space-separated string: re-renders only when the set changes.

function useKeyCommandActions(): string

ui/src/keybindings/KeyCommands.tsx:116

The registry of the nearest KeyCommandsProvider, or null outside one.

function useKeyCommandRegistry(): KeyCommandRegistry | null

ui/src/keybindings/KeyCommands.tsx:85

Registers handlers with the nearest KeyCommandsProvider for as long as the component is mounted. A fresh object each render costs nothing: handlers are read at press time. Outside a provider it does nothing.

function useKeyCommands(commands: KeyCommands): void

ui/src/keybindings/KeyCommands.tsx:95

The bindings in effect (defaults plus the host's overrides), re-rendering when the overrides change.

function useMergedKeybindings(): KeyBindings

ui/src/keybindings/KeybindingsProvider.tsx:88

Props for FooterHint.

interface FooterHintProps

ui/src/keybindings/KeyHint.tsx:53

Props for KeybindingsProvider.

interface KeybindingsProviderProps

ui/src/keybindings/KeybindingsProvider.tsx:56

Props for KeyCommandsProvider.

interface KeyCommandsProviderProps

ui/src/keybindings/KeyCommands.tsx:37

Props for KeyHint.

interface KeyHintProps

ui/src/keybindings/KeyHint.tsx:14

Options of pressChord.

interface PressChordOptions

ui/src/keybindings/press.ts:47

A handler per action the caller binds.

type KeybindingHandlers = KeyCommands

ui/src/keybindings/KeybindingsProvider.tsx:111