npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

my-hotkeys

v0.0.2

Published

Keyboard shorcuts

Downloads

12

Readme

Build Status License: MIT

my-hotkeys

Keyboard shortcuts.

Install

$ npm install my-hotkeys

Basic Usage

import {hotkeys} from 'my-hotkeys`;
const hk = hotkeys();

// bind one:
hk.bind('a', doSomething);

// or multiple:
hk.bind({
	'a': doSomething,
	'ctrl-a': doSomethingElse,
	'ctrl-alt-3': doAnotherThing,
});

hk.unbind('a'); // removes a hotkey

hk.unmount(); // removes the instance's event listener
hk.mount(); // adds the instance's event listener

hk.destruct(); // removes all hotkeys and the event listener

Index

Creating an instance

There are two ways to get a Hotkeys instance:

  1. By calling hotkeys creator function (lowercased "h")
  2. By the Hotkeys constructor (uppercased "H")
import {hotkeys} from 'my-hotkeys`;

const hk = hotkeys();

or:

import {Hotkeys} from 'my-hotkeys`;

const hk = new Hotkeys();

The difference between them is that hotkeys creator function also mounts the event listener on creation and doesn't have the ignore function argument (yet). When using the constructor you need to call .mount() manually (see .mount() below) and you can also set an ignore function.

Both accept an optional argument as the context element (HTMLElement | Document). This would be the element that listens to the keyboard events. Defaults to document.

const hk = hotkeys(elmOrDoc);
// => internally: elmOrDoc.addEventListener()...

⚠ Non-browser environments: You might need to pass in the runtime's document object as the constructor argument.

Ignore Function

By default, the Hotkeys instance ignores key presses if the event.target element is:

  • <input>
  • <select>
  • <textarea>
  • [contenteditable="true"]

You can pass the constructor your own ignore function as the second argument. This function gets called on every keydown event with the event object. Return a truthy value to ignore the key press or a falsy value for continue executing the hotkey.

const hk = new Hotkeys(document, (ev: KeyboardEvent) =>
	ev.target === mySpecialElement);

Binding / Unbinding Keys

.bind()

  • .bind(hotkey, callback) - hotkey string, callback
  • .bind({hotkey: callback}) - an object of {hotkey:callback}

Adds keyboard shortcuts. Does not add an event listener.

hk.bind('a', doSomething);
hk.bind('b', doSomethingElse);

// or:

hk.bind({
  'a': doSomething,
  'b': doSomethingElse,
});

Each hotkey can be bound once:

hk.bind('a', doSomething);
hk.bind('a', doSomethingElse); // -> throws Error

Callback functions are called with the keyboard event as their only argument:

function doSomething (ev: KeyboardEvent) {...}

.unbind()

  • .unbind(hotkey) - hotkey string
  • .unbind([hotkey...]) - an array of hotkey strings

Removes keyboard shortcuts. Does not remove the event listener.

hk.unbind('a');
hk.unbind('b');

// or:

hk.unbind(['a', 'b']);

.unbindAll()

Unbinds all hotkeys. Does not remove the event listener.

hk.bind('A', doSomething);

hk.unbindAll();

hk.bind('B', doSomethingElse);

Mount/Unmount the event listener

Each Hotkeys instance can only have one keydown keyboard event listener. The event listener is attached to the context element passed in construction. Defaults to document.

  • .mount() - Attaches the event listener to the context element.
  • .unmount() - Dettaches the event listener from the context element.
const hk = new Hotkeys(myMenu);

hk.bind('Q', doSomething);

// user presses "Q" but nothing happens

hk.mount(); // => internally: myMenu.addEventListener()...

// user presses "Q" and `doSomething` is called

hk.unmount();

// user presses "Q" but nothing happens

Using the creator function mounts the event listener for you:

const hk = hotkeys(); //  <---- also mounts

hk.bind('Q', doSomething);

// user presses "Q" and `doSomething` is called

hk.unmount();

// user presses "Q" but nothing happens

Hotkeys Strings

Currently, my-hotkeys supports the classic/standard/canonical way of binding keys: there are modifier keys (Control, Alt, Shift, Meta) and all the rest ("regular" keys).

A hotkey string can be a single regular key, with or without modifiers.

Modifier keys cannot be hotkeys without a regular key, i.e. .bind('ctrl-alt') will not work.

You can also bind by event.code or by symbols like ?.

Delimiter

The delimiter character is -, not configurable (yet?). If you want to bind - as a hotkey - use its alias: "Minus" (e.g. 'ctrl-minus').

Examples:

hk.bind({
	'a': doSomething,
	'ctrl-a': doSomething,
	'ctrl-alt-a': doSomething,
	'?': showHelp, // by symbol that may require shift
})

Hotkeys are case insensitive:

hk.bind('ctrl-a', doSomething)
// Same as:
hk.bind('Ctrl-A', doSomething)

But not when you bind by a key id (event.code):

// event.code is case sensitive
hk.bind('Numpad8', doSomething)

Aliases

Some keys have aliases for better readability or just for convenience.

Aliases are case insensitive.

Modifier Aliases:

| Key | Alias | |---------|---------| | Control | Ctrl | | Meta | Cmd | | Meta | Command |

Regular Key Aliases:

| Key | Alias | |------------|--------------| | ArrowUp | Up | | ArrowDown | Down | | ArrowLeft | Left | | ArrowRight | Right | | | Space | | + | Plus | | - | Minus | | = | Equal | | _ | Underscore | | ' | Quote | | ' | Singlequote | | " | Quotes | | " | Doublequotes | | ` | Backquote | | ~ | Tilde | | \ | Backslash | | Insert | Ins | | Delete | Del | | Escape | Esc | | PageUp | PgUp | | PageDown | PgDn |

Destruction

Call .destruct() when its context element leaves the DOM. It will remove all of the instance's hotkeys and event listeners by calling .unmount() and .unbindAll().

const hk = new Hotkeys();

hk.bind('A', doSomething);
hk.mount();

// ...

hk.destruct();