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

dom-event-key

v1.0.1

Published

dom-event-key simplifies handling browser keyboard events

Downloads

94

Readme

dom-event-key

dom-event-key simplifies handling browser keyboard events by providing a convenient way to check if a given key event matches a specified shortcut key.

Install

npm install dom-event-key

Usage

import { equalEventKey } from 'dom-event-key';

// Detect shortcut key from keyboard events
window.addEventListener('keydown', (e) => {
  if (equalEventKey('Ctrl+k', e)) {
    alert('Ctrl+k pressed');
  }
});

API

createEventKeys(state[, options]) => string[]

Generates an array of string representations of keyboard event keys based on the provided state object.

window.addEventListener('keydown', (e) => {
  console.log(createEventKeys(e)); // => ex. ['Modifier+k', 'Control+k']
});

parseEventKey(key[, options]) => state

Parses the given string representation of a keyboard event key and returns the corresponding state object.

console.log(parseEventKey('Ctrl+k')); // => { ctrlKey: true, key: 'k', ... }

equalEventKey(keyOrState, otherKeyOrState) => boolean

Compares two keyboard event keys or state objects and returns true if they are equal, false otherwise.

window.addEventListener('keydown', (e) => {
  console.log(equalEventKey('Ctrl+k', e)); // => true OR false
});