KeybindingInput

interface

Fields accepted by keybinding.

interface KeybindingInput<TCommand extends Command | string>

Import

import { KeybindingInput } from '@modular/sdk';

argsoptional: readonly unknown[]
Arguments handed to the command when the chord fires.
command: TCommand
The command value, or the id of a command declared elsewhere.
id: string
Identifier for the binding itself, distinct from the command it runs.
key: string
Default chord, for example `'ctrl+shift+u'`.
linuxoptional: string
Chord used on Linux instead of `key`.
macoptional: string
Chord used on macOS instead of `key`.
systemWideoptional: boolean
whenoptional: Condition<string>
Condition that must hold for the chord to be active.
winoptional: string
Chord used on Windows instead of `key`.