Hotkeys API Reference

createHotkey

Function: createHotkey()

function createHotkey(
   hotkey, 
   callback, 
   options): void;

function createHotkey(
   hotkey, 
   callback, 
   options): void;

Defined in: packages/svelte-hotkeys/src/createHotkey.svelte.ts:56

Parameters

hotkey

MaybeGetter<RegisterableHotkey>

callback

HotkeyCallback

options

MaybeGetter<CreateHotkeyOptions> = {}

Returns

void

Example

svelte

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

  createHotkey('Mod+S', () => {
    console.log('Mod+S pressed')
  })
</script>

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

  createHotkey('Mod+S', () => {
    console.log('Mod+S pressed')
  })
</script>