Docs
CodeRabbit
Cloudflare
Railway
OpenRouter
AG Grid
Clerk
WorkOS
Netlify
SerpAPI
Electric
Sentry
Prisma
Unkey
CodeRabbit
Cloudflare
Railway
OpenRouter
AG Grid
Clerk
WorkOS
Netlify
SerpAPI
Electric
Sentry
Prisma
Unkey
API Reference
Hotkeys API Reference
Hotkey Sequence API Reference
Key hold & held keys API Reference
Hotkey Recorder API Reference
Hotkey Sequence Recorder API Reference
Normalization & format API Reference
Hotkey Sequence API Reference

createHotkeySequencesAttachment

Function: createHotkeySequencesAttachment()

ts
function createHotkeySequencesAttachment(definitions, commonOptions): Attachment<HTMLElement>;
function createHotkeySequencesAttachment(definitions, commonOptions): Attachment<HTMLElement>;

Defined in: packages/svelte-hotkeys/src/createHotkeySequences.svelte.ts:184

Create an attachment for element-scoped multi-sequence registration.

Parameters

definitions

MaybeGetter<CreateHotkeySequenceDefinition[]>

commonOptions

MaybeGetter<CreateHotkeySequenceOptions> = {}

Returns

Attachment<HTMLElement>

Example

svelte
<script lang="ts">
  import { createHotkeySequencesAttachment } from '@tanstack/svelte-hotkeys'

  const vim = createHotkeySequencesAttachment([
    { sequence: ['G', 'G'], callback: () => scrollToTop() },
    { sequence: ['D', 'D'], callback: () => deleteLine() },
  ])
</script>

<div tabindex="0" {@attach vim}>Editor</div>
<script lang="ts">
  import { createHotkeySequencesAttachment } from '@tanstack/svelte-hotkeys'

  const vim = createHotkeySequencesAttachment([
    { sequence: ['G', 'G'], callback: () => scrollToTop() },
    { sequence: ['D', 'D'], callback: () => deleteLine() },
  ])
</script>

<div tabindex="0" {@attach vim}>Editor</div>