Hotkey Sequence API Reference

createSequenceMatcher

Function: createSequenceMatcher()

ts
function createSequenceMatcher(sequence, options): object;

Defined in: sequence-manager.ts:636

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

HotkeySequence

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()

ts
getProgress: () => number;

Returns

number

match()

ts
match: (event) => boolean;

Parameters

event

KeyboardEvent

Returns

boolean

reset()

ts
reset: () => void;

Returns

void

Example

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

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