块编辑器开发文档

@wordpress/router

💡 云策文档标注

概述

@wordpress/router 是一个通用包,用于在 WordPress 包中实现浏览器路由功能。它需要 ES2015+ 环境支持,并可通过 npm 安装。

关键要点

  • 安装方式:使用 npm install @wordpress/router --save 进行安装。
  • 环境要求:需要 ES2015+ 环境,否则需包含 @wordpress/babel-preset-default 中的 polyfill。
  • API 状态:privateApis 部分目前未提供文档说明。
  • 贡献方式:作为 Gutenberg 项目的一部分,遵循其贡献指南进行开发。

📄 原文内容

Router is a generic package that allows to use browser routing in WordPress packages.

Installation

Install the module

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

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.