Commands
Commands is a generic package that allows registering and modifying commands to be displayed using the commands menu (Also called cmd+k).
Installation
Install the module
npm install @wordpress/commands --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
CommandMenu
Undocumented declaration.
privateApis
Undocumented declaration.
store
Store definition for the commands namespace.
Related
Type
useCommand
Attach a command to the command palette.
Parameters
- command
import('../store/actions').WPCommandConfig
: command config.
useCommandLoader
Attach a command loader to the command palette.
Parameters
- loader
import('../store/actions').WPCommandLoaderConfig
: command loader config.
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.