TanStack
App Hotkeys API Reference

AppHotkeysStoreOptions

Defined in: app-hotkeys.ts:325

Options for AppHotkeysStore.

Type Parameters

T

T extends AppHotkeys = AppHotkeys

Properties

customHotkeys?

ts
optional customHotkeys?: CustomHotkeys<T> | null;

Defined in: app-hotkeys.ts:327

Starting custom hotkeys, such as saved data. Invalid entries are ignored with a warning.


onCustomHotkeysChange?

ts
optional onCustomHotkeysChange?: (customHotkeys) => void;

Defined in: app-hotkeys.ts:329

Called with the custom hotkeys after every change, ready to save.

Parameters

customHotkeys

CustomHotkeys<T>

Returns

void


platform?

ts
optional platform?: Platform;

Defined in: app-hotkeys.ts:331

Platform used to compare hotkeys. Defaults to detection.