TanStack
Hotkeys

createMultiHotkeyHandler

ts
function createMultiHotkeyHandler(handlers, options?): (event) => void;

Defined in: match.ts:138

Creates a handler that matches multiple hotkeys.

Parameters

handlers

MultiHotkeyHandler

A map of hotkey strings to their handlers

options?

CreateHotkeyHandlerOptions = {}

Options for matching and handling

Returns

A function that can be used as an event handler

(event) => void

Example

ts
const handler = createMultiHotkeyHandler({
  'Mod+S': (event, { hotkey }) => handleSave(),
  'Mod+Z': (event, { hotkey }) => handleUndo(),
  'Mod+Shift+Z': (event, { hotkey }) => handleRedo(),
})

document.addEventListener('keydown', handler)
Edit on GitHub
Core API