createKeybindRegistry

function createKeybindRegistry<S>(scopes): KeybindRegistry<S>;

Create a static keybind registry from a scope→keybinds mapping.

The returned registry object exposes the raw data together with helper methods for command lookup, help generation, and scope queries.

Type Parameters

Type Parameter
S extends string

Parameters

Parameter	Type	Description
scopes	Record<S, KeybindDef[]>	A record mapping scope names to arrays of keybind definitions.

Returns

KeybindRegistry<S>

A frozen KeybindRegistry instance.

Example

import { createKeybindRegistry } from "@semos-labs/glyph";

const registry = createKeybindRegistry({
  global: [
    { key: "?", display: "?", description: "Show help", action: "openHelp", command: "help" },
    { key: ":", display: ":", description: "Open command bar", action: "openCommand" },
    { key: "q", display: "q", description: "Quit", action: "quit", command: "quit" },
  ],
  list: [
    { key: "j", display: "j / ↓", description: "Next item", action: "next" },
    { key: "down", display: "j / ↓", description: "Next item", action: "next" },
    { key: "k", display: "k / ↑", description: "Previous item", action: "prev" },
    { key: "up", display: "k / ↑", description: "Previous item", action: "prev" },
    { key: "return", display: "Enter", description: "Open item", action: "open" },
  ],
});

---

KeybindDef

A single keybind definition within a scope.

Example

const def: KeybindDef = {
  key: "shift+d",
  display: "D",
  description: "Delete item",
  action: "delete",
  command: "delete",
};

Properties

Property	Type	Description
action	string	Action identifier used to look up the handler in a handlers map.
command?	string	Optional command name for the command palette. Omit to exclude from commands.
description	string	Short description of what the keybind does.
display	string	Human-readable display string shown in help dialogs (e.g. "D", "Ctrl+u").
key	string	Key combo string used for matching (e.g. "shift+d", "ctrl+u", ":"). Leave empty ("") for command-only entries with no keyboard shortcut.

---

CommandDef

A command entry extracted from the registry.

Properties

Property	Type	Description
action	string	Action identifier to dispatch.
description	string	Description of the command.
name	string	The command name (from KeybindDef.command).

---

KeybindRegistry

A typed keybind registry with helper methods.

Created by createKeybindRegistry. Provides access to the raw scope→keybind mapping and convenience methods for command lookup, help generation, and more.

Example

const commands = registry.getAllCommands();
const match = registry.findCommand("goto tomorrow");
const help = registry.getKeybindsForHelp("timeline");

Type Parameters

Type Parameter	Default type
S extends string	string

Methods

findCommand()

findCommand(input):
  | {
  action: string;
  args?: string;
  name: string;
}
  | null;

Find a command by user input text.

Supports exact matches and parameterised commands (e.g. "goto <date>" matches input "goto tomorrow" with args = "tomorrow").

Parameters

Parameter	Type	Description
input	string	Raw user input from the command bar.

Returns

| { action: string; args?: string; name: string; } | null

Matched command with optional args, or null.

---

getAllCommands()

getAllCommands(): CommandDef[];

Collect every keybind that has a command field, sorted by name.

Returns

CommandDef[]

Sorted array of command definitions.

---

getKeybindsForHelp()

getKeybindsForHelp(context, options?): {
  keybinds: KeybindDef[];
  title: string;
}[];

Build sections for a help dialog: context-specific, related sub-modes, then global keybinds.

Parameters

Parameter	Type	Description
context	S	The primary scope to display.
options?	HelpOptions<S>	Optional related scopes and titles.

Returns

{ keybinds: KeybindDef[]; title: string; }[]

Ordered sections for rendering.

---

getKeybindsForScope()

getKeybindsForScope(scope): KeybindDef[];

Get de-duplicated keybinds for a scope (unique by display).

Parameters

Parameter	Type	Description
scope	S	Scope name.

Returns

KeybindDef[]

Keybinds with duplicate display values removed.

Properties

Property	Modifier	Type	Description
scopes	readonly	Readonly<Record<S, KeybindDef[]>>	The raw scope→keybinds mapping.

---

HelpOptions

Options for KeybindRegistry.getKeybindsForHelp.

Type Parameters

Type Parameter
S extends string

Properties

Property	Type	Description
globalScope?	S	Which scope is the global scope (always appended last). Default: "global" if it exists in the registry, otherwise omitted.
related?	S[]	Related sub-mode scopes to include after the primary scope.
scopeTitles?	Partial<Record<S, string>>	Human-readable titles for scopes. Falls back to the scope key.