块编辑器开发文档

@wordpress/core-commands

💡 云策文档标注

概述

@wordpress/core-commands 是一个包含可重用 WordPress 管理命令的 npm 包,适用于多个 WP Admin 页面。它需要 ES2015+ 环境支持,并作为 Gutenberg 项目的一部分进行维护。

关键要点

  • 提供可重用的 WordPress Admin 命令,用于初始化 Command Palette。
  • 安装方式:通过 npm install @wordpress/core-commands --save 安装。
  • 环境要求:需要 ES2015+ 环境,否则需包含 @wordpress/babel-preset-default 的 polyfill。
  • API 包括 initializeCommandPalette 函数,接受 settings 对象作为参数。
  • 此包是 Gutenberg 项目的一部分,采用 monorepo 结构,贡献指南请参考项目主文档。

📄 原文内容

This package includes a list of reusable WordPress Admin commands. These commands can be used in multiple WP Admin pages.

Installation

Install the module

npm install @wordpress/core-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

initializeCommandPalette

Initializes the Command Palette.

Parameters

  • settings Object: Command palette settings.

privateApis

Undocumented declaration.

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.