# HotkeyMetadata

Source: /tuil/docs/reference/packages/hotkeys/api/hotkey-metadata
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 HotkeyMetadata {
  readonly title?: string;
  readonly description?: string;
  readonly category?: string;
  readonly commandId?: string;
  readonly visibleInHelp?: boolean;
  readonly platforms?: readonly NodeJS.Platform[];
}
```

## Members [#members]

| Member          | Type                                      | Required | Description                                                                         | Related types |
| --------------- | ----------------------------------------- | -------- | ----------------------------------------------------------------------------------- | ------------- |
| `title`         | `string \| undefined`                     | No       | The `title` member uses the `string \| undefined` contract.                         | —             |
| `description`   | `string \| undefined`                     | No       | The `description` member uses the `string \| undefined` contract.                   | —             |
| `category`      | `string \| undefined`                     | No       | The `category` member uses the `string \| undefined` contract.                      | —             |
| `commandId`     | `string \| undefined`                     | No       | The `commandId` member uses the `string \| undefined` contract.                     | —             |
| `visibleInHelp` | `boolean \| undefined`                    | No       | The `visibleInHelp` member uses the `boolean \| undefined` contract.                | —             |
| `platforms`     | `readonly NodeJS.Platform[] \| undefined` | No       | The `platforms` member uses the `readonly NodeJS.Platform[] \| undefined` 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]

No package-local related types.

## 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)