TanStack
Hotkeys API Reference

AlpineCreateHotkey

Defined in: types.ts:99

Registers a hotkey: a chord, a sequence, or an app hotkey.

Call Signature

ts
AlpineCreateHotkey<T>(
   hotkey, 
   callback, 
   options?): void;

Defined in: types.ts:100

Registers a hotkey: a chord, a sequence, or an app hotkey.

Type Parameters

T

T extends AppHotkey<string, HotkeyChord | HotkeySequence | null>

Parameters

hotkey

MaybeGetter<T>

callback

HotkeyCallback

options?

MaybeGetter<AlpineAppHotkeyOptions<T>>

Returns

void

Call Signature

ts
AlpineCreateHotkey<T>(
   hotkey, 
   callback, 
   options?): void;

Defined in: types.ts:105

Registers a hotkey: a chord, a sequence, or an app hotkey.

Type Parameters

T

T extends RegisterableHotkey

Parameters

hotkey

MaybeGetter<T>

callback

HotkeyCallback

options?

MaybeGetter<AdapterOptionsFor<T, AlpineHotkeyTarget>>

Returns

void