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 todiv
.
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.