KeyboardShortcutDefinition

KeyboardShortcutDefinition = object

Defined in: keyboard-shortcuts.ts:33

Definition of a keyboard shortcut with platform-specific keyboard event definitions.

default keyboard event definitions are required while the apple keyboard event definitions are optional.

Example

const boldShortcut: KeyboardShortcutDefinition = {
  default: [{
    key: 'B',
    alt: false,
    ctrl: true,
    meta: false,
    shift: false,
  }],
  apple: [{
    key: 'B',
    alt: false,
    ctrl: false,
    meta: true,
    shift: false,
  }],
}

Beta

This API should not be used in production and may be trimmed from a public release.

Properties

apple?

optional apple: ReadonlyArray<KeyboardEventDefinition>

Defined in: keyboard-shortcuts.ts:35

---

default

default: ReadonlyArray<KeyboardEventDefinition>

Defined in: keyboard-shortcuts.ts:34