# @10up/component-navigation 中文文档

规范地址：https://npmcn.com/package/%4010up/component-navigation/

版本：2\.1\.5
npm 元数据更新时间：2026-08-21T19:38:52.392Z
中文译文更新时间：2026-11-06T17:00:23.236Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%4010up/component-navigation
原文对照：https://npmcn.com/package/%4010up/component-navigation/?lang=original
项目主页：https://github.com/10up/component-navigation#readme
源码仓库：https://github.com/10up/component-navigation

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：236 kB，20 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2018-11-12T16:15:41.826Z
- 最新版本发布：2023-04-17T23:18:37.178Z
- 近 30 天下载量：2666（2026-10-04 至 2026-11-02，npm 官方下载统计）
- 已发布版本数：14（近 12 个月 0 个）

## 中文简介

可访问导航组件.

## 安装

```sh
npm install @10up/component-navigation
```

也可以使用：`pnpm add @10up/component-navigation`、`yarn add @10up/component-navigation`、`bun add @10up/component-navigation`

## README

# 10up 导航组件

> 无障碍和反应灵敏的导航组件.

## 安装

### 国家预防机制

`npm install --save @10up/component-navigation`

### 独立

克隆此还原并导入 `navigation.js` 财务报告和审定财务报表 `navigation.css` 从 `dist/` 目录.

## API 密码

此组件接受两个参数,即导航容器的选择器和一个包含配置设置和可选回调的对象.

### 设置

-   `action`: 用于打开菜单项目的动作 _(默认) **盘旋**_
-   `breakpoint`: 切换到小屏幕菜单的 Viewport 断点 _(默认) **(明-微: 48**_

### 回电

-   `onCreate`: 组件初始化后在页面负荷中调用
-   `onOpen`: 打开菜单项时调用
-   `onClose`: 当菜单项关闭时调用
-   `onSubmenuOpen`: 打开子菜单项时调用
-   `onSubmenuClose`: 当子菜单项关闭时调用

## 使用量

### 标记

这是组件预期的标记模板 .

```html
<nav class="site-navigation" itemscope="itemscope" itemtype="http://schema.org/SiteNavigationElement">

   <a href="#primary-nav" aria-controls="primary-nav" class="site-menu-toggle">
       <span class="screen-reader-text">Primary Menu</span>
       <span aria-hidden="true">☰</span>
   </a>

   <?php
       wp_nav_menu( array(
           'theme_location' => 'primary',
           'menu_class'     => 'primary-menu',
           'menu_id'        => 'primary-nav',
           ) );
   ?>

</nav>
```

### 支助科

样式可以通过使用 PostCSS 导入来导入到您现有的代码库, 或者通过将独立的 CSS 文件包含在您的工程中 .

#### PostCSS 导入

`@import '@10up/component-navigation';`

#### 独立

包含 `navigation.css` 从文档 `dist/` 目录.

### Java 脚本

通过提供用于导航的选取器和包含任何必要配置设置和回调函数的对象来创建新实例 .

#### 国家预防机制

```javascript
import Navigation from '@10up/component-navigation';

new Navigation( '.navigation', {
    action: 'click',
    onCreate: function() {
        console.log( 'onCreate callback' );
    },
    onOpen: function() {
        console.log( 'onOpen callback' );
    },
    onClose: function() {
        console.log( 'onClose callback' );
    },
    onSubmenuOpen: function() {
        console.log( 'onSubmenuOpen callback' );
    },
    onSubmenuClose: function() {
        console.log( 'onSubmenuClose callback' );
    }
} );
```

#### 独立

包含 `navigation.js` 从文档 `dist/` 目录和从 gobal 访问组件 `TenUp` 对象.

```javascript
let myNavigation = new TenUp.navigation( '.navigation', {
    action: 'click',
    onCreate: function() {
        console.log( 'onCreate callback' );
    },
    onOpen: function() {
        console.log( 'onOpen callback' );
    },
    onClose: function() {
        console.log( 'onClose callback' );
    },
    onSubmenuOpen: function() {
        console.log( 'onSubmenuOpen callback' );
    },
    onSubmenuClose: function() {
        console.log( 'onSubmenuClose callback' );
    }
} );
```

## 演示

执行实例可参见: `demo` 目录.

## 支助级别

**活动 :** 10up公司正在积极开展这方面的工作,我们期望在可预见的未来继续工作,包括不断测试最新的WordPress版本。 欢迎错误报告、特性请求、问题和拉动请求.

## 就像你看到的一样?

[![10up](https://10up.com/uploads/2016/10/10up-Github-Banner.png)](http://10up.com/contact/)

## 常见问题

### @10up/component-navigation 是什么？

可访问导航组件\.

### 如何安装 @10up/component-navigation？

在项目目录运行 npm install @10up/component-navigation，或使用 pnpm add / yarn add / bun add。

### @10up/component-navigation 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @10up/component-navigation 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @10up/component-navigation 可以商用吗？

@10up/component-navigation 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @10up/component-navigation 的下载量有多少？

根据 npm 官方下载统计，@10up/component-navigation 在 2026/10/04 – 2026/11/02 这 30 天内被下载 2,666 次，日均约 89 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @10up/component-navigation 还在维护吗？

最新版本 2\.1\.5 发布于 2023/04/18（3 年前）；至今共发布 14 个版本，其中过去 12 个月发布了 0 个；首次发布于 2018/11/13。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。