# @canonical/global-nav 中文文档

规范地址：https://npmcn.com/package/%40canonical/global-nav/

版本：4\.0\.0
npm 元数据更新时间：2026-11-03T13:27:41.925Z
中文译文更新时间：2026-11-09T01:10:39.252Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40canonical/global-nav
原文对照：https://npmcn.com/package/%40canonical/global-nav/?lang=original
项目主页：https://github.com/canonical-web-and-design/global-nav#readme
源码仓库：https://github.com/canonical-web-and-design/global-nav

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

- 包体积（解压后）：212 kB，6 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：1 个
- 首次发布：2019-03-07T21:33:21.649Z
- 最新版本发布：2026-11-03T13:27:41.613Z
- 近 30 天下载量：16540（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：46（近 12 个月 2 个）

## 中文简介

显示横跨网站顶端的 Canonical 全球导航的脚本和样式表

## 安装

```sh
npm install @canonical/global-nav
```

也可以使用：`pnpm add @canonical/global-nav`、`yarn add @canonical/global-nav`、`bun add @canonical/global-nav`

## README

# Canonical 全球导航

此工程包含 JavaScript 和样式, 用于在其中添加一个“ All Canonical” 导航滴入项 [香草导航模式](https://vanillaframework.io/docs/patterns/navigation#global-navigation)。 。 。 .

降下包含一个Canonical生态系统网站列表,使一个用户能够轻松地跳过核心站点.

## 重要 - 不要使用3.7.x 版本

全球导航3.7.x、3.7.x和3.7.x版本对下放菜单的滑动导航进行了修改, 不知此工程只应包含“ All Canonical” 链接的代码 我们大部分网站的导航.

3.8.0版本中所有这些改动都已恢复,3.6.4版本的编码相同 (3.7.0前释放).

## 使用量

使用节点软件包管理器安装此组件,然后将JS文件链接到您站点的头部,带有可选设置.

样式将自动注入页面 `<head>`。 。 。 .

1.  通过纱线或 npm 安装

```bash
yarn add @canonical/global-nav

```

或者说...

```bash
npm install @canonical/global-nav --save
```

2.  然后可以通过直接链接或通过ES6导入来安装库.

要直接使用该图书馆,请在JS文件中添加一个链接,其中包含 [IIFE (英语)](https://developer.mozilla.org/en-US/docs/Glossary/IIFE) 运行 `canonicalGlobalNav.createNav()` 函数;

```html
<script src="/node_modules/@canonical/global-nav/dist/iife.js"></script>
<script>
  canonicalGlobalNav.createNav();
</script>
```

要导入它,只需从你的全网站JS文件中调用它;

```js
import { createNav } from '@canonical/global-nav';
createNav();
```

3.  然后您需要添加 `.global-nav` 类为 a `ul.p-navigation__items` 。导航模式中的元素。 模块将查找此类, 并添加下拉作为列表的第一个项目 .

### 字体

从4.0.0版本开始,注入的样式不再包括Ubuntu字体. 导航 `"Ubuntu variable"` 但期望页面能加载它.

-   **如果你的网站使用香草**,你已经有了: 香草的基底样式包括字体.
-   **如果您的网站主机字体本身**,没有改变:导航使用您 `@font-face` 规则.
-   **否则**在您网站的CSS中添加这些规则:

```css
@font-face {
  font-family: 'Ubuntu variable';
  font-stretch: 100%;
  font-style: normal;
  font-weight: 100 800;
  font-display: swap;
  src: url('https://assets.ubuntu.com/v1/f1ea362b-Ubuntu%5Bwdth,wght%5D-latin-v0.896a.woff2') format('woff2');
}

@font-face {
  font-family: 'Ubuntu variable';
  font-stretch: 100%;
  font-style: italic;
  font-weight: 100 800;
  font-display: swap;
  src: url('https://assets.ubuntu.com/v1/90b59210-Ubuntu-Italic%5Bwdth,wght%5D-latin-v0.896a.woff2') format('woff2');
}
```

这些都是相同的文件 香草装载。 没有它们,导航就会回到系统字体.

### 选项

这个 `createNav` 函数带有以下属性的选项对象:

-   `breakpoint`: 该点以像素为单位,导航开关在桌面和移动布局之间. 默认是 `620px`,用于反映 `$breakpoint-navigation-threshold` 香草(见 [香草的断点文件](https://vanillaframework.io/docs/settings/breakpoint-settings)) (中文(简体) ).
    
-   `mobileContainerSelector` 财务报告和审定财务报表 `desktopContainerSelector`: 选择器(可以是"id"或"class"),用于附加全局导航的移动和桌面视图. 这也将绕过默认事件听从者被附加,因为他们依赖于默认结构,所以自定义JS将是nessacary. 还有这个,班级 `global-nav` 仍然应该用于表示“全条”标签按钮的位置。 如果使用 Ony , 它会使默认的全球导航 .
    

如果 `$breakpoint-navigation-threshold` 香草变量在您的项目中被覆盖, 您需要设置此选项在全球导航上 .

例如,设置 `breakpoint` 改为 `1036`数字 :

```html
<script src="/node_modules/@canonical/global-nav/dist/index.js"></script>

<script>
  canonicalGlobalNav.createNav({
    breakpoint: 1036,
    mobileContainerSelector: 'global-nav-mobile',
    desktopContainerSelector: 'global-nav-desktop',
  });
</script>
```

如果你正在进口;

```js
import { createNav } from '@canonical/global-nav';
createNav({ breakpoint: 1036 });
```

## 建设全球导航

将联署材料纳入 `/dist` 文件夹, 运行 :

```bash
./run build
```

## 本地运行项目

本地运行最简单的方式是首先 [安装嵌入器](https://docs.docker.com/engine/installation/) (在Linux上,你可能需要 [将您的用户添加到 `docker` 组](https://docs.docker.com/engine/installation/linux/linux-postinstall/)),然后使用 `./run` 脚本 :

```bash
./run
```

你也可以使用这个 [点数快取](https://snapcraft.io/dotrun),通过运行:

```bash
dotrun
```

集装箱装好后,你就可以参观了 [http://127.0.0.1:8300 (中文(简体) )](http://127.0.0.1:8300/) 在您的浏览器中.

### 监视已更改的文件

因为工作 [Sass 文件](https://npmcn.com/package/%40canonical/global-nav/src/sass) 财务报告和审定财务报表 [联合来文文件](https://npmcn.com/package/%40canonical/global-nav/src/js) 中,您可能想要动态地监视修改,以在有变化时重建 dist 文件.

要设置监视器,请打开一个新的终端窗口并运行:

```bash
./run watch
```

在提交拉拉请求之前 进行测试 检查JS和Sass是否出错.

```
./run test
```

### 如何添加内置 svgs

只是因为有点痛, 这就是我所做的.

1.  [收缩svg](https://www.svgminify.com/) 尽可能多
2.  上传到其他资产服务器 - OPTIONAL
3.  在浏览器中查看并抓取源代码.
4.  从双倍转换引号 `"` 改为单 `'` - 绿色
5.  [编码 svg](https://meyerweb.com/eric/tools/dencoder/)
6.  将此添加为 `data:image/svg+xml,` 在产品细节的正确位置。 编

### 香草的更新

该项目使用 [香草框架](https://vanillaframework.io/) 直接导入 SCSS 文件以构建全局导航本身的样式( 通过 `vanilla-framework` npm 软件包, 以依赖性定义 [软件包.json](https://github.com/canonical/global-nav/blob/main/package.json))和演示页的样式(通过在 [索引.html](https://github.com/canonical/global-nav/blob/main/index.html) 存档).

将香草更新到最新版本时 **两个依赖关系** 应更新.

### 释放过程

软件包使用 [语义版本](https://semver.org/) 并公布于国家预防机制登记册.

要剪切新发布运行 :

```bash
npm version [patch|minor|major]
```

这将触发 `prepublishonly` 脚本将确保在出版前建立必要的手工艺品.

代码许可LGPLv3 由Canonical Ltd.

和来自Canonical的..

## 常见问题

### @canonical/global-nav 是什么？

显示横跨网站顶端的 Canonical 全球导航的脚本和样式表

### 如何安装 @canonical/global-nav？

在项目目录运行 npm install @canonical/global-nav，或使用 pnpm add / yarn add / bun add。

### @canonical/global-nav 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/canonical\_\_global-nav 是否存在。

### @canonical/global-nav 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @canonical/global-nav 可以商用吗？

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

### @canonical/global-nav 的下载量有多少？

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

### @canonical/global-nav 还在维护吗？

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