PrepareHotkeyDefinitionsOptions | TanStack Hotkeys Docs

Context for prepareHotkeyDefinitions.

Type Parameters

TTarget

Properties

appHotkeysStore?

optional appHotkeysStore?: 
  | AppHotkeysStore<Readonly<Record<string, AppHotkey<string, HotkeyChord | HotkeySequence | null>>>>
  | null;

optional appHotkeysStore?: 
  | AppHotkeysStore<Readonly<Record<string, AppHotkey<string, HotkeyChord | HotkeySequence | null>>>>
  | null;

Defined in: adapter.ts:251

The provider's app hotkeys store, so app hotkeys use custom hotkeys.

commonOptions?

optional commonOptions?: AdapterCommonOptions<TTarget>;

optional commonOptions?: AdapterCommonOptions<TTarget>;

Defined in: adapter.ts:255

Options for every definition, applied after app hotkey declarations.

defaults?

optional defaults?: AdapterCommonOptions<TTarget>;

optional defaults?: AdapterCommonOptions<TTarget>;

Defined in: adapter.ts:253

Provider defaults, applied first.

resolveTarget?

optional resolveTarget?: (target) => Target | null | undefined;

optional resolveTarget?: (target) => Target | null | undefined;

Defined in: adapter.ts:261

Resolves a framework target, such as a ref. Return undefined for the document or null to skip registration until the target exists. Without it, targets pass through and null means document.