Skip to content
TanStackHotkeys

AdapterHotkeyDefinition

ts
type AdapterHotkeyDefinition<TTarget> = 
  | {
  callback: HotkeyCallback;
  hotkey: RegisterableHotkeyChord;
  options?: AdapterChordOptions<TTarget>;
}
  | {
  callback: HotkeyCallback;
  hotkey: RegisterableHotkeySequence;
  options?: AdapterSequenceOptions<TTarget>;
}
  | {
  callback: HotkeyCallback;
  hotkey: AppHotkey;
  options?: Omit<AdapterCommonOptions<TTarget>, "meta">;
}
  | {
  callback: HotkeyCallback;
  hotkey: RegisterableHotkey | null | undefined;
  options?: AdapterHotkeyOptions<TTarget>;
};

Defined in: adapter.ts:238

One hotkey and its callback for adapter APIs such as useHotkeys. Chords accept requireReset; sequences accept timeout; hotkeys of unknown kind accept only shared options.

Type Parameters

TTarget

TTarget

Union Members

Type Literal

ts
{
  callback: HotkeyCallback;
  hotkey: RegisterableHotkeyChord;
  options?: AdapterChordOptions<TTarget>;
}

callback

ts
callback: HotkeyCallback;

The function to call when the hotkey is pressed

hotkey

ts
hotkey: RegisterableHotkeyChord;

A chord string such as 'Mod+S', or a chord object

options?

ts
optional options?: AdapterChordOptions<TTarget>;

Per-hotkey options (merged on top of common options)

Type Literal

ts
{
  callback: HotkeyCallback;
  hotkey: RegisterableHotkeySequence;
  options?: AdapterSequenceOptions<TTarget>;
}

callback

ts
callback: HotkeyCallback;

hotkey

ts
hotkey: RegisterableHotkeySequence;

A sequence such as ['G', 'G'], with each step a string or an object

options?

ts
optional options?: AdapterSequenceOptions<TTarget>;

Type Literal

ts
{
  callback: HotkeyCallback;
  hotkey: AppHotkey;
  options?: Omit<AdapterCommonOptions<TTarget>, "meta">;
}

callback

ts
callback: HotkeyCallback;

hotkey

ts
hotkey: AppHotkey;

An app hotkey from defineAppHotkeys. Kind-specific options apply only while its effective hotkey has that kind.

options?

ts
optional options?: Omit<AdapterCommonOptions<TTarget>, "meta">;

Type Literal

ts
{
  callback: HotkeyCallback;
  hotkey: RegisterableHotkey | null | undefined;
  options?: AdapterHotkeyOptions<TTarget>;
}

callback

ts
callback: HotkeyCallback;

hotkey

ts
hotkey: RegisterableHotkey | null | undefined;

A hotkey whose kind is not known statically, such as user data typed Hotkey. Accepts only shared options. undefined, null, and '' register nothing, for an optional shortcut.

options?

ts
optional options?: AdapterHotkeyOptions<TTarget>;
Edit on GitHub
Core API