# useHotkey API

> Auto-generated API reference for `useHotkey` from @vuetify/v0 (Vuetify0).
> Source of truth: https://0.vuetifyjs.com/api/use-hotkey

## Related

- https://0.vuetifyjs.com/composables/system/use-hotkey
- https://0.vuetifyjs.com/composables/system/use-event-listener
- https://0.vuetifyjs.com/composables/system/use-click-outside

## Functions

### useHotkey

A composable that listens for hotkey combinations and sequences.

```ts
(keys: MaybeRefOrGetter<string | undefined>, callback: (e: KeyboardEvent) => void, options?: UseHotkeyOptions, _platform?: PlatformContext | undefined) => UseHotkeyReturn
```

## Options

| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| `event` | `MaybeRefOrGetter<"keydown" \| "keyup"> \| undefined` | `'keydown'` | no | The keyboard event type to listen for. |
| `inputs` | `MaybeRefOrGetter<boolean> \| undefined` | `false` | no | Whether to trigger the callback when an input element is focused. |
| `preventDefault` | `MaybeRefOrGetter<boolean> \| undefined` | `true` | no | Whether to prevent the default browser action. |
| `stopPropagation` | `MaybeRefOrGetter<boolean> \| undefined` | `false` | no | Whether to stop event propagation. |
| `sequenceTimeout` | `MaybeRefOrGetter<number> \| undefined` | `1000` | no | Timeout in ms before a key sequence resets. |

## Methods

| Name | Type | Description |
|---|---|---|
| `pause` | `() => void` | Pause listening (removes listener but keeps configuration). |
| `resume` | `() => void` | Resume listening after pause. |
| `stop` | `() => void` | Stop listening and clean up (removes listener). |

## Properties

| Name | Type | Description |
|---|---|---|
| `isActive` | `Readonly<Ref<boolean, boolean>>` | Whether the hotkey listener is currently active (listening for keys). False when paused, when keys is undefined, or in SSR. |
| `isPaused` | `Readonly<Ref<boolean, boolean>>` | Whether the hotkey listener is currently paused. |