Skip to main content

HotkeyHook()

HotkeyHook = void

HotkeyHook(): void

A React hook that manages a hotkey. When mounted, it will activate the hotkey. When all instances are unmounted, it will deactivate the hotkey.

Returns

void

Methods

forceBind()

forceBind(): CleanupFunction

Force bind the hotkey. Ignores the hooks mounted state.

Returns

CleanupFunction


forceUnbind()

forceUnbind(): void

Force unbind the hotkey. Ignores the hooks mounted state.

Returns

void

Properties

config

config: HotkeyConfig

The full hotkey config


id

id: HotkeyId

The id of the hotkey


isBound

isBound: boolean

Whether the hotkey is currently bound