@svelte-put/shortcut

@svelte-put/shortcut

Svelte action use:shortcut - add event listener for keyboard shortcuts

Table of Contents

Show / hide

• @svelte-put/shortcut
  • Table of Contents
  • svelte-put
  • Changelog
  • Installation
  • Usage
  • Documentation
    • Typescript support

svelte-put

This package is part of the @svelte-put family. For contributing guideline and more, refer to its readme.

Changelog

Installation

npm install -D @svelte-put/shortcut
yarn add -D @svelte-put/shortcut
pnpm add -D @svelte-put/shortcut

Usage

See example for typical usage here.

Documentation

Typescript support

app.d.ts: show / hide

/// <reference types="@sveltejs/kit" />
/// <reference types="svelte" />

// Typescript support in svelte-kit, see
// https://github.com/sveltejs/language-tools/blob/master/docs/preprocessors/typescript.md#im-using-an-attributeevent-on-a-dom-element-and-it-throws-a-type-error

declare namespace svelte.JSX {
  interface HTMLAttributes<T> {
    // on:shortcut
    onshortcut?: (event: CustomEvent<import('@svelte-put/shortcut').ShortcutEventDetails>) => void;
  }
}

For detailed documentation, see the extracted API.

Quick access to the parameter interface accepted by the action: ShortcutParameters.