@wordpress/keyboard-shortcuts
Edit
Keyboard shortcuts is a generic package that allows registering and modifying shortcuts.
Installation 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 API
ShortcutProvider ShortcutProvider
Handles callbacks added to context by useShortcut
.
Parameters
- props
Object
: Props to pass todiv
.
Returns
import('@wordpress/element').WPElement
: Component.
store store
Store definition for the keyboard shortcuts namespace.
Related
Type
Object
useShortcut 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.