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

@wordpress/keyboard-shortcuts

v5.12.0

Published

Handling keyboard shortcuts.

Downloads

269,761

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

riadriadgutenbergplugingutenbergpluginmamadukamamadukaryanwelcherryanwelchergarypendergastgarypendergastadamsilversteinadamsilversteingziologziolontwbntwbnoisysocksnoisysockskadamwhitekadamwhitejorgefilipecostajorgefilipecostaellatrixellatrixiandunn206iandunn206whyisjakewhyisjakeockhamockhamsirrealsirrealnosoloswnosoloswwpisabelwpisabelntsekourasntsekourasnerradnerraddesrosjdesrosjtalldanwptalldanwppeterwilsonccpeterwilsoncc

Keywords

wordpressgutenbergkeycodes

Readme

Keyboard Shortcuts

Keyboard shortcuts is a generic package that allows registering and modifying shortcuts.

Installation

Install the module

npm install @wordpress/keyboard-shortcuts --save

This package assumes that your code will run in an ES2015+ environment. If you're using an environment that has limited or no support for such language features and APIs, you should include the polyfill shipped in @wordpress/babel-preset-default in your code.

API

ShortcutProvider

Handles callbacks added to context by useShortcut. Adding a provider allows to register contextual shortcuts that are only active when a certain part of the UI is focused.

Parameters

  • props Object: Props to pass to div.

Returns

  • Element: Component.

store

Store definition for the keyboard shortcuts namespace.

Related

Type

  • Object

useShortcut

Attach a keyboard shortcut handler.

Parameters

  • name string: Shortcut name.
  • callback Function: Shortcut callback.
  • options Object: Shortcut options.
  • options.isDisabled boolean: Whether to disable to shortut.

Contributing to this package

This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to npm and used by WordPress as well as other software projects.

To find out more about contributing to this package or Gutenberg as a whole, please read the project's main contributor guide.