createHotkeySequence

function createHotkeySequence(
   sequence, 
   callback, 
   options?): void;

Defined in: createHotkeySequence.ts:64

SolidJS primitive for registering a keyboard shortcut sequence (Vim-style).

This primitive allows you to register multi-key sequences like 'g g' or 'd d' that trigger when the full sequence is pressed within a timeout.

Each step may include modifiers. You can chain the same modifier across steps (e.g. Shift+R then Shift+T). Modifier-only keydown events (Shift, Control, Alt, or Meta pressed alone) are ignored while matching—they do not advance the sequence or reset progress.

Parameters#

sequence#

HotkeySequence | (() => HotkeySequence)

Array of hotkey strings that form the sequence (or accessor function)

callback#

HotkeyCallback

Function to call when the sequence is completed

options?#

| CreateHotkeySequenceOptions | (() => CreateHotkeySequenceOptions)

Options for the sequence behavior (or accessor function)

Returns#

void

Example#

function VimEditor() {
  // 'g g' to go to top
  createHotkeySequence(['G', 'G'], () => {
    scrollToTop()
  })

  // 'd d' to delete line
  createHotkeySequence(['D', 'D'], () => {
    deleteLine()
  })

  // 'd i w' to delete inner word
  createHotkeySequence(['D', 'I', 'W'], () => {
    deleteInnerWord()
  }, { timeout: 500 })

  // Same modifier on consecutive steps (bare Shift between chords is ignored)
  createHotkeySequence(['Shift+R', 'Shift+T'], () => {
    nextAction()
  })

  return <div>...</div>
}