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

# createKeyboardShortcut

> **createKeyboardShortcut**\<`TKeyboardEvent`\>(`definition`): [`KeyboardShortcut`](/api/keyboard-shortcuts/type-aliases/keyboardshortcut/)\<`TKeyboardEvent`\>

Defined in: keyboard-shortcuts.ts:86

Creates a `KeyboardShortcut` from a `KeyboardShortcutDefinition`.

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

## Type Parameters

### TKeyboardEvent

`TKeyboardEvent` *extends* `Pick`\<`KeyboardEvent`, `"key"` \| `"code"` \| `"altKey"` \| `"ctrlKey"` \| `"metaKey"` \| `"shiftKey"`\> = `Pick`\<`KeyboardEvent`, `"key"` \| `"code"` \| `"altKey"` \| `"ctrlKey"` \| `"metaKey"` \| `"shiftKey"`\>

## Parameters

### definition

[`KeyboardShortcutDefinition`](/api/keyboard-shortcuts/type-aliases/keyboardshortcutdefinition/)

## Returns

[`KeyboardShortcut`](/api/keyboard-shortcuts/type-aliases/keyboardshortcut/)\<`TKeyboardEvent`\>

## Example

```typescript
const shortcut = createKeyboardShortcut({
  default: [{
    key: 'B',
    alt: false,
    ctrl: true,
    meta: false,
    shift: false,
  }],
  apple: [{
    key: 'B',
    alt: false,
    ctrl: false,
    meta: true,
    shift: false,
  }],
})
```