@wordpress/route

查看官方原文 ↗

💡 云策文档标注

概述

@wordpress/route 是 WordPress 管理界面的路由工具包，提供 TanStack Router 的共享实例，确保路由一致性。它包含公共 API 如钩子和组件，以及用于路由器设置的私有 API。

关键要点

提供 TanStack Router 的共享实例，用于 WordPress 管理界面路由
公共 API 包括 Link、useNavigate、useParams、useRouter、useSearch 等钩子和组件
私有 API 用于路由器设置，不应由单个路由直接使用
作为 Gutenberg 项目的一部分，采用 monorepo 结构，支持贡献

代码示例

import { Link, useNavigate, useParams, useRouter, useSearch } from '@wordpress/route';

function MyRoute() {
    const params = useParams();
    const navigate = useNavigate();
    const search = useSearch();

    return (
        <div>
            <Link to="/other-route">Go to other route</Link>
            <button onClick={() => navigate({ to: '/somewhere' })}>
                Navigate
            </button>
        </div>
    );
}

注意事项

私有 API 仅供 boot 包用于路由器设置，开发者应避免在路由中直接使用
此包是 Gutenberg 项目的一部分，贡献需遵循项目指南

📄 原文内容

Routing utilities for WordPress admin interfaces, providing a shared instance of TanStack Router.

Installation

Install the module:

npm install @wordpress/route --save

Usage

This package provides a shared instance of TanStack Router to ensure consistent routing across WordPress admin interfaces.

Public API

The following hooks and components are available for use in routes:

import { Link, useNavigate, useParams, useRouter, useSearch } from '@wordpress/route';

function MyRoute() {
    const params = useParams();
    const navigate = useNavigate();
    const search = useSearch();

    return (
        <div>
            <Link to="/other-route">Go to other route</Link>
            <button onClick={() => navigate({ to: '/somewhere' })}>
                Navigate
            </button>
        </div>
    );
}

Private API

The boot package uses private APIs for router setup. These should not be used by individual routes.

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.

To find out more about contributing to this package or Gutenberg as a whole, please read the project’s main contributor guide.

云策 WordPress 开发者社区

块编辑器开发文档