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

# KeyboardShortcut

> **KeyboardShortcut**\<`TKeyboardEvent`\> = `object`

Defined in: keyboard-shortcuts.ts:46

A resolved keyboard shortcut for the current platform that has been
processed by `createKeyboardShortcut(...)` to select the appropriate
platform-specific key combination. The `guard` function determines if the
shortcut applies to the current `KeyboardEvent`, while `keys` contains the
display-friendly key combination for the current platform.

## Type Parameters

### TKeyboardEvent

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

## Properties

### guard()

> **guard**: (`event`) => `boolean`

Defined in: keyboard-shortcuts.ts:55

#### Parameters

##### event

`TKeyboardEvent`

#### Returns

`boolean`

***

### keys

> **keys**: `ReadonlyArray`\<`string`\>

Defined in: keyboard-shortcuts.ts:56