# Hotkey

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

function exported by @mwillbanks/tuil-hotkeys.



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

## function [#function]

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

```ts
export function Hotkey(
  props: Omit<HotkeyBinding, "handler"> & {
    readonly onTrigger: HotkeyBinding["handler"];
  },
): null;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member  | Type                                                                                                 | Required | Description                                                                                                                         | Related types                                                          |
| ------- | ---------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| `props` | `Omit<HotkeyBinding, "handler"> & &#123;     readonly onTrigger: HotkeyBinding["handler"];   &#125;` | Yes      | Supplies the `props` value as `Omit<HotkeyBinding, "handler"> & &#123;     readonly onTrigger: HotkeyBinding["handler"];   &#125;`. | [`HotkeyBinding`](/tuil/docs/reference/packages/hotkeys/api/hotkey-binding) |

## Returns [#returns]

`null` — Returns a value that satisfies `null`.

Related types: —

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