keys

Import

Import

import * as api from "@fungi.computer/nacre/keys";

Exports

Kind	Export	Description
Ttype alias	ShellChord	One physical chord parsed from a Whistle binding such as alt+left.
Ttype alias	KeyEventFacts	Keyboard facts shared by DOM events and terminal adapters.
Ttype alias	LeaderKey	One key offered after the leader chord, with the command it runs.
Ttype alias	ShellKeyHost	The shell host operations the key dispatcher reads.
fnfunction	parseChord()	Parse one single-chord binding. Sequences (including <leader>x) and unknown modifiers return null; they are never matched as one chord.
fnfunction	chordMatches()	Whether one key event is exactly this chord.
fnfunction	leaderKeys()	The single-keystroke <leader>x rows, first binding per key.
fnfunction	leaderKeyMatches()	Whether one key event (after the leader) selects this leader key.
fnfunction	installShellKeys()	Dispatch the active view’s single-chord bindings from the shell document. Text entry is a mode: while an input is focused only Ctrl/Cmd chords fire, so Alt-arrows keep their word-navigation meaning.

ShellChordTtype alias

Signature

type ShellChord = Readonly<{
  key: string;
  alt: boolean;
  ctrl: boolean;
  meta: boolean;
  shift: boolean;
}>;

One physical chord parsed from a Whistle binding such as alt+left.

---

KeyEventFactsTtype alias

Signature

type KeyEventFacts = Pick<
  KeyboardEvent,
  "altKey" | "ctrlKey" | "key" | "metaKey" | "shiftKey"
>;

Keyboard facts shared by DOM events and terminal adapters.

---

LeaderKeyTtype alias

Signature

type LeaderKey = WhistleBindingProjection &
  Readonly<{
    key: string;
  }>;

One key offered after the leader chord, with the command it runs.

---

ShellKeyHostTtype alias

Signature

type ShellKeyHost = Readonly<{
  active: () => WhistleSnapshot;
  subscribe: (listener) => () => void;
  execute: (commandId, input) => Promise<WhistleExecutionOutcome>;
}>;

The shell host operations the key dispatcher reads.

parseChord()fnfunction

Signature

function parseChord(
  binding,
  mac,
): Readonly<{
  key: string;
  alt: boolean;
  ctrl: boolean;
  meta: boolean;
  shift: boolean;
}> | null;

Parse one single-chord binding. Sequences (including <leader>x) and unknown modifiers return null; they are never matched as one chord.

Parameters

Parameter	Type
binding	string
mac	boolean

Returns

| Readonly<{ key: string; alt: boolean; ctrl: boolean; meta: boolean; shift: boolean; }> | null

---

chordMatches()fnfunction

Signature

function chordMatches(event, chord): boolean;

Whether one key event is exactly this chord.

Parameters

Parameter	Type
event	KeyEventFacts
chord	ShellChord

Returns

boolean

---

leaderKeys()fnfunction

Signature

function leaderKeys(active): readonly LeaderKey[];

The single-keystroke <leader>x rows, first binding per key.

Parameters

Parameter	Type
active	WhistleSnapshot

Returns

readonly LeaderKey[]

---

leaderKeyMatches()fnfunction

Signature

function leaderKeyMatches(event, key): boolean;

Whether one key event (after the leader) selects this leader key.

Parameters

Parameter	Type
event	Pick<KeyboardEvent, "altKey" | "ctrlKey" | "key" | "metaKey">
key	string

Returns

boolean

---

installShellKeys()fnfunction

Signature

function installShellKeys(root, host, mac): () => void;

Dispatch the active view’s single-chord bindings from the shell document. Text entry is a mode: while an input is focused only Ctrl/Cmd chords fire, so Alt-arrows keep their word-navigation meaning.

Parameters

Parameter	Type
root	HTMLElement
host	ShellKeyHost
mac	boolean

Returns

() => void