UI kit reference

zidane-ui/keybindings/testing

import { … } from 'zidane-ui/keybindings/testing'ui/src/keybindings/testing/index.ts

Functions#

Creates a KeybindingsHost held in memory.

TypeScript

function createFixtureKeybindingsHost(
  options?: FixtureKeybindingsOptions,
): FixtureKeybindingsHost

Parameters
Name	Type	Default	Description
options?	`FixtureKeybindingsOptions`	`{}`	The stored overrides, and whether they can be saved.

FixtureKeybindingsHost

Changes the stored overrides from outside.

TypeScript

interface FixtureKeybindingsControl

FixtureKeybindingsControl properties
Name	Type	Description
store	`(overrides: Readonly<Record<string, string>>) => void`	The file changed on disk (the next `refresh` reads it).
stored	`() => Readonly<Record<string, string>>`	The stored map now.

TypeScript

interface FixtureKeybindingsOptions

FixtureKeybindingsOptions properties
Name	Type	Description
editable?	`boolean`	Offer `save`. Default: true.
overrides?	`Readonly<Record<string, string>>`	The stored overrides (action → spec; unknown actions are dropped on read). Default: none.

An in-memory KeybindingsHost and its control.

TypeScript

type FixtureKeybindingsHost = KeybindingsHost & { control: FixtureKeybindingsControl }