TanStack
Hotkeys API Reference

HotkeysProvider

ts
function HotkeysProvider(__namedParameters): ElementDescriptor<{
  children: unknown;
  value: {
     appHotkeysStore:   | AppHotkeysStore<Readonly<Record<string, AppHotkey<string, HotkeyChord | HotkeySequence | null>>>>
        | null;
     defaultOptions: DefaultHotkeysOptions;
  };
}>;

Defined in: HotkeysProvider.ts:70

Sets defaults, app hotkeys, and custom hotkeys for descendant components.

Parameters

__namedParameters

HotkeysProviderProps

Returns

ElementDescriptor<{ children: unknown; value: { appHotkeysStore: | AppHotkeysStore<Readonly<Record<string, AppHotkey<string, HotkeyChord | HotkeySequence | null>>>> | null; defaultOptions: DefaultHotkeysOptions; }; }>