> For the complete documentation index, see [llms.txt](/llms.txt).
> The full corpus is at [llms-full.txt](/llms-full.txt).

# 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

```typescript
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,
  }],
}
```

## Properties

### apple?

> `optional` **apple**: `ReadonlyArray`\<[`KeyboardEventDefinition`](/api/keyboard-shortcuts/type-aliases/keyboardeventdefinition/)\>

Defined in: keyboard-shortcuts.ts:35

***

### default

> **default**: `ReadonlyArray`\<[`KeyboardEventDefinition`](/api/keyboard-shortcuts/type-aliases/keyboardeventdefinition/)\>

Defined in: keyboard-shortcuts.ts:34