@cetfox24/shortcuts v1.0.3

shortcuts

Simple shortcut library made by Casper Kuethe

Installation

npm install @cetfox24/shortcuts

Usage

import Shortcuts from '@cetfox24/shortcuts'

const options = {
  callback () {
    // callback code
  }
}

// Add as many characters as you want 
Shortcuts.on(options, "ctrl", "s", "a")
// Or
const characters = ["ctrl", "s", "a"]
Shortcuts.on(options, ...characters)

You will get autocomplete on some values that are hard-typed, but you can use any value equal to Event.key

Examples

Add an on save (ctrl+s) shortcut

import Shortcuts from '@cetfox24/shortcuts'

Shortcuts.on({
    callback () {
        console.log("save")
    }
}, "ctrl", "s")
// ------- or -------
import { Shortcut } from '@cetfox24/shortcuts'

new Shortcut({
    callback () {
        console.log("save")
    }
}, "ctrl", "s")

API Class ShortcutBus

The export default value has the type ShortcutBus

import { ShortcutBus } from '@cetfox24/shortcuts'

// The callback interface for all listeners
interface ShortcutCallback {
    (event: KeyboardEvent): void
}
// Options interface
interface ShortcutOptions {
    callback: ShortcutCallback
    stopProppagation?: boolean
    preventDefault?: boolean
}

Add a callback when the specified characters are all pressed

ShortcutBus.on(options: ShortcutOptions, ...characters: ShortcutCharacter[])

Remove a callback

ShortcutBus.off(callback: ShortcutCallback, ...characters: ShortcutCharacter[])

Remove all callbacks

ShortcutBus.offAll()

The keyup and keydown events are initiated on construction if the window object is defined. Call ShortcutBus.attach() to attach all eventListeners to the window object. And use ShortcutBus.detach() to detach the eventListeners from the window object.

API Class Shortcut

Shortcut constructor see ShortcutBus.on

import { Shortcut } from '@cetfox24/shortcuts'

new Shortcut(options: ShortcutOptions, ...characters: ShortcutCharacter[])

The keyup and keydown events are initiated on construction if the window object is defined. Call Shortcut.attach() to attach all eventListeners to the window object. And use Shortcut.detach() to detach the eventListeners from the window object.

Other API

ShortcutCharacter

// To keep track of metadeta so autocomplete will work
type OtherString = string & {}
type ShortcutCharacter = 'a'|'b'|'c'|'d'|'e'|'f'|'g'|'h'|'i'|'j'|
                         'k'|'l'|'m'|'n'|'o'|'p'|'q'|'r'|'s'|'t'|
                         'u'|'v'|'w'|'x'|'y'|'z'|
                         'ctrl'|'shift'|'alt'|'tab' | OtherString

ShortcutCallback

export interface ShortcutCallback {
    (event: KeyboardEvent): void
}

ShortcutOptions

export interface ShortcutOptions {
    callback: ShortcutCallback
    stopProppagation?: boolean
    preventDefault?: boolean
}