云策 WordPress 开发者社区

块编辑器开发文档

@wordpress/widgets

查看官方原文 ↗
💡 云策文档标注

概述

@wordpress/widgets 包提供小部件块编辑器在 Widgets 屏幕和 Customizer 中使用的通用功能。该包主要面向 WordPress 核心开发，但也可用于其他项目，但请注意其文档可能不完整。

关键要点

  • 包用途：为小部件块编辑器提供核心功能，支持 Widgets 屏幕和 Customizer。
  • 使用环境：要求 ES2015+ 环境，否则需包含 @wordpress/babel-preset-default 中的 polyfill。
  • 安装方式：通过 npm install @wordpress/widgets 安装。
  • 贡献指南：作为 Gutenberg 项目的一部分，遵循 monorepo 结构，贡献请参考项目主指南。
📄 原文内容

This package contains common functionality used by the widgets block editor in the Widgets screen and the Customizer.

This package is meant to be used only with WordPress core. Feel free to use it in your own project but please keep in mind that it might never get fully documented.

Installation

Install the module

npm install @wordpress/widgets

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.

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.