# HotkeyEvent

Source: /tuil/docs/reference/packages/hotkeys/api/hotkey-event
Locale: en

interface exported by @mwillbanks/tuil-hotkeys.



{/* Generated by tooling/docs/generate-reference.ts. */}

## interface [#interface]

Public interface exported by `@mwillbanks/tuil-hotkeys`.

```ts
export interface HotkeyEvent {
  readonly keys: string;
  readonly input: string;
  readonly sequence: readonly string[];
  readonly binding: HotkeyBinding;
  defaultPrevented: boolean;
  preventDefault(): void;
}
```

## Members [#members]

| Member             | Type                | Required | Description                                                  | Related types                                                          |
| ------------------ | ------------------- | -------- | ------------------------------------------------------------ | ---------------------------------------------------------------------- |
| `keys`             | `string`            | Yes      | The `keys` member uses the `string` contract.                | —                                                                      |
| `input`            | `string`            | Yes      | The `input` member uses the `string` contract.               | —                                                                      |
| `sequence`         | `readonly string[]` | Yes      | The `sequence` member uses the `readonly string[]` contract. | —                                                                      |
| `binding`          | `HotkeyBinding`     | Yes      | The `binding` member uses the `HotkeyBinding` contract.      | [`HotkeyBinding`](/tuil/docs/reference/packages/hotkeys/api/hotkey-binding) |
| `defaultPrevented` | `boolean`           | Yes      | The `defaultPrevented` member uses the `boolean` contract.   | —                                                                      |
| `preventDefault`   | `() => void`        | Yes      | The `preventDefault` member uses the `() => void` contract.  | —                                                                      |

## Parameters [#parameters]

This declaration has no public members.

## Returns [#returns]

This declaration does not return a value.

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`HotkeyBinding`](/tuil/docs/reference/packages/hotkeys/api/hotkey-binding)

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/hotkeys/src/index.ts)

## Package [#package]

[@mwillbanks/tuil-hotkeys](/tuil/docs/reference/packages/hotkeys)