shortcutter
TypeScript icon, indicating that this package has built-in type declarations

0.2.0 • Public • Published

SHORTCUTTER

Tiny, dependency-free library to manage keyboard shortcuts in your application.

Getting started

  1. Install the library from npm registry:
npm install --save shortcutter
  1. Import the necessary parts into your project:
import {PHASES, useShortcutter} from 'shortcutter';
  1. Use shortcutter to start using shortcuts:
const shortcutter = useShortcutter();
  1. Add your first key binding
shortcutter.listen(
  // context, where you would like to add a shortcut
  'default', 
  // keys, which invoke callback
  ['a', 's'],
  // callback which `shortcutter` should invoke
  (event: Event, phase: PHASES) => alert(`My first key binding on ${phase}`),
  // phases when `shortcutter` should invoke callback 
  PHASES.DOWN_PRESS_UP,
);
  1. Open your test application in browser, and press A + S

API

Types

PHASES

The string-type PHASES contains all possible variants of the shortcut's status.

Variant Value
PHASES.DOWN down
PHASES.PRESS press
PHASES.UP up
PHASES.DOWN_PRESS down|press
PHASES.DOWN_UP down|up
PHASES.PRESS_UP press|up
PHASES.DOWN_PRESS_UP down|press|up

Interfaces

useShortcutter

Returns interface to control contexts and shortcuts.

const {
  listen,
  unlisten,
  hasContext,
  getActiveContext
  setActiveContext
} = useShortcutter();

shortcutter.listen

Adds a listener for defined keys into the shortcutter's context.

Arguments Type Description
context string ---
keys string[] ---
callback (event: Event, phases: PHASES) => void ---
phases PHASES ---

Returns shortcutter.unlisten.

shortcutter.unlisten

Removes a listener for defined keys from the shortcutter's context.

Arguments Type Description
context string ---
keys string[] ---
phases PHASES ---

shortcutter.hasContext

Checks if a passed context is already added to Shortcutter.

Arguments Type Description
name string ---

shortcutter.getActiveContext

Returns active context's name.

shortcutter.setActiveContext

Sets passed context as the active one.

Arguments Type Description
name string ---

Versioning

This library follows Semantic Versioning.

License

Shortcutter is available under the MIT license. See the LICENSE file for more details.

Crafted with ❤️ to 📋 and 🔑

Package Sidebar

Install

npm i shortcutter

Weekly Downloads

1

Version

0.2.0

License

MIT

Unpacked Size

47.9 kB

Total Files

32

Last publish

Collaborators

  • swistach