Skip to content

KeyboardShortcuts

uitemplate

A group of bindings belonging to the same category

Installation

$ bunx termuijs add keyboard-shortcuts

Copies the source into src/components/keyboard-shortcuts/ and installs @termuijs/core, @termuijs/widgets.

Usage

ts
import { KeyboardShortcuts } from '@termuijs/ui'
ts
new KeyboardShortcuts(bindings: ShortcutBinding[], options: KeyboardShortcutsOptions = {})

API Reference

KeyboardShortcuts

PropTypeRequiredDescription
bindingsShortcutBinding[]required
keyColorStyle['fg']optionalColor for the key label boxes
categoryColorStyle['fg']optionalColor for category headings
columnsnumberoptionalNumber of columns (default 2)
showCategoriesbooleanoptionalShow category headings (default true)
#template#keyboard-shortcuts