# @gemeente-denhaag/sidenav 中文文档

规范地址：https://npmcn.com/package/%40gemeente-denhaag/sidenav/

版本：2\.0\.0
npm 元数据更新时间：2026-09-02T13:20:59.623Z
中文译文更新时间：2026-11-16T02:31:32.174Z
软件包许可：EUPL-1\.2

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

原始 npm 页面：https://www.npmjs.com/package/%40gemeente-denhaag/sidenav
原文对照：https://npmcn.com/package/%40gemeente-denhaag/sidenav/?lang=original
项目主页：https://github.com/nl-design-system/denhaag#readme
源码仓库：https://github.com/nl-design-system/denhaag

弃用说明：Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.

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

- 包体积（解压后）：35.7 kB，19 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：react 18 \|\| 19，react-dom 18 \|\| 19
- 首次发布：2022-04-26T07:30:38.439Z
- 最新版本发布：2025-02-25T15:21:43.587Z
- 近 30 天下载量：7953（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：245（近 12 个月 0 个）

## 中文简介

一个侧向导航组件

## 安装

```sh
npm install @gemeente-denhaag/sidenav
```

也可以使用：`pnpm add @gemeente-denhaag/sidenav`、`yarn add @gemeente-denhaag/sidenav`、`bun add @gemeente-denhaag/sidenav`

## README

# 侧向导航

下通航被用作通航元素. 这显示为移动和桌面侧边栏上的覆盖 .

## 何时使用

Sidenav是指帮助用户访问站点信息架构中下等类别的导航UI. 这些类别或页数与主菜单分开。 用户可以通过点击该类别的名称来浏览这些页面.

目标是:

### 最低互动费用

用户应能够尽量不费力地访问对导航感兴趣的要素.

### 典型路径支持

如果在一个会话内,用户有可能从一个区段的一页跳到另一个区段的一页,那么子导航就应该能够轻松地进行.

### 可发现性

用户应该能够快速地找到子导航UI,没有机会将其与主导航混淆.

## 替代品和相关构成部分

-   使用链接进行句子内或句子后立即出现的导航动作.
-   对不出现在句子内或直接出现在句子后的行动使用按钮.

## 解剖学

潜水包括:

1.  标签: 通讯正在链接的内容
2.  图标 (可选): 此图标给出标签的额外指导
3.  箭头:显示下面有菜单项的图标
4.  集装箱

## (互动)状态

子导航包含不活动状态,活动状态,徘徊状态和聚焦状态.

## 设计属性

### 类型

#### 大块

-   标签不活动: Sans/ lg/ 400
-   标签活动: The Sans/lg/700

#### 小型

-   标签不活动: Sans/ md/ 400
-   标签活动: The Sans/ md/700

### 颜色

-   标签不活动: 文本颜色 Grey/4
-   标签活动: 文本颜色 Blue/3
-   图标不活动: svg 颜色 Grey/4
-   启用图标: svg 颜色 Blue/3
-   箭头不活动: svg 颜色 Grey/4
-   箭头活动: svg 颜色 Blue/3

### 交互式状态

-   不活跃的 Hover: 标签文本颜色 Blue/3
-   焦点:容器边框颜色 Ocher/5

### 结构

#### 图标,图标+箭头,图标+通知

##### 大块

-   标签: 贴上右侧 16px
-   图标:高度和宽度 20px, 贴地- 右 16px
-   箭头:高度和宽度 24px
-   集装箱:高度48px

##### 小型

-   标签: 贴上右侧 16px
-   图标:高度和宽度 20px, 贴地- 右 16px
-   箭头:高度和宽度 20px
-   集装箱:高度48px

#### 图标 + 箭头已扩展

##### 大块

-   标签: 贴上右侧 8px
-   图标:高度和宽度 20px, 贴地- 右 16px
-   箭头:高度和宽度 24px
-   集装箱:高度48px

##### 小型

-   标签: 贴上右侧 8px
-   图标:高度和宽度 20px, 贴地- 右 16px
-   箭头:高度和宽度 20px
-   集装箱:高度48px

## 无障碍

\[技术要求\]

## 内容准则

-   标签必须明确和可预测。 用户在选择标签时应该能够预见到他们将去的地方.
-   总是使用子导航标签,指第一个单词是大写,而其他是小写(除非一个名词有自己的名).
-   标签应短而甜,最多可有2个字.
-   使标签易于扫描.
-   了解用户在寻找什么,并使用熟悉和相关分类标签。 Menus不是用编造的词和内部词汇变得可爱的地方. 坚持术语清晰地描述您的内容和特征.
-   避免“条款”或“视频”等通用标签。 这些标签并非是描述性的.

## 最佳做法

### 编号

潜水必须:

-   显示用户可以使用的页面名 .
-   有逻辑顺序。 您可能想要按优先排序选项—— 从最优先开始, 以最不重要选项结束 .
-   在移动中显示“大”和“小”中的主要导航要素.
-   如果该元素内有通知,则在标签后贴上徽章.
-   在下面有菜单项时使用扩展后箭头, 只允许有一层嵌入项 .

### 不要这样

潜水必须:

-   未创建信息超载 .
-   没有太多的导航,因为选项使得下一步变得不明确.
-   如果主元素和子元素存在差异,则不以一个大小显示所有导航元素.

## 参考资料

[https://www.nngroup.com/articles/menu-design/ (中文(中国大陆) )](https://www.nngroup.com/articles/menu-design/) [https://forgeandsmith.com/blog/website-navigation-ux-best-practices/ 互联网档案馆的存檔,存档日期2013-12-21](https://forgeandsmith.com/blog/website-navigation-ux-best-practices/) [https://xd.adobe.com/ideas/process/information-architecture/website-navigation-design-est-practices/ 互联网档案馆的存檔,存档日期2013-12-02](https://xd.adobe.com/ideas/process/information-architecture/website-navigation-design-best-practices/)

## 常见问题

### @gemeente-denhaag/sidenav 是什么？

一个侧向导航组件注意：该包已被作者标记为弃用——Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.

### 如何安装 @gemeente-denhaag/sidenav？

在项目目录运行 npm install @gemeente-denhaag/sidenav，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（18 \|\| 19）、react-dom（18 \|\| 19）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @gemeente-denhaag/sidenav 支持 TypeScript 吗？

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

### @gemeente-denhaag/sidenav 支持 ESM 还是 CommonJS？

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

### @gemeente-denhaag/sidenav 可以商用吗？

@gemeente-denhaag/sidenav 使用 EUPL-1\.2 许可。声明的许可为 EUPL-1\.2，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @gemeente-denhaag/sidenav 的下载量有多少？

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

### @gemeente-denhaag/sidenav 还在维护吗？

最新版本 2\.0\.0 发布于 2025/02/25（1\.7 年前）；至今共发布 245 个版本，其中过去 12 个月发布了 0 个；首次发布于 2022/04/26。作者已将其标记为弃用，新项目建议寻找替代方案。

