createSequenceMatcher | TanStack Hotkeys Docs

function createSequenceMatcher(sequence, options?): object;

function createSequenceMatcher(sequence, options?): object;

Defined in: match.ts:233

Creates a simple sequence matcher for one-off use.

This is a low-level helper that does not support ignoreInputs, target, or other HotkeyOptions. Callers must handle input filtering themselves if attaching to document.

Parameters

sequence

RegisterableHotkeySequence

The sequence of hotkeys to match

options?

Options including timeout

platform?

"mac" | "windows" | "linux"

timeout?

number

Returns

object

An object with match() and reset() methods

getProgress

getProgress: () => number;

getProgress: () => number;

Returns

number

match

match: (event) => boolean;

match: (event) => boolean;

Parameters

event

KeyboardEvent

Returns

boolean

reset

reset: () => void;

reset: () => void;

Returns

void

Example

const matcher = createSequenceMatcher(['G', 'G'], { timeout: 500 })

document.addEventListener('keydown', (event) => {
  if (matcher.match(event)) {
    console.log('Sequence matched!')
  }
})

const matcher = createSequenceMatcher(['G', 'G'], { timeout: 500 })

document.addEventListener('keydown', (event) => {
  if (matcher.match(event)) {
    console.log('Sequence matched!')
  }
})