# @govuk-one-login/service-header 中文文档

规范地址：https://npmcn.com/package/%40govuk-one-login/service-header/

版本：7\.0\.1
npm 元数据更新时间：2026-10-20T13:54:56.853Z
中文译文更新时间：2026-11-16T20:58:01.121Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40govuk-one-login/service-header
原文对照：https://npmcn.com/package/%40govuk-one-login/service-header/?lang=original
项目主页：https://github.com/govuk-one-login/service-header#readme
源码仓库：https://github.com/govuk-one-login/service-header

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

- 包体积（解压后）：114 kB，16 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：1 个
- peer 依赖：govuk-frontend ^6\.5\.1
- 首次发布：2026-01-12T08:50:34.085Z
- 最新版本发布：2026-10-20T13:54:56.330Z
- 近 30 天下载量：16904（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 6 个）

## 中文简介

使用 GOV.UK One 登录服务的标题

## 安装

```sh
npm install @govuk-one-login/service-header
```

也可以使用：`pnpm add @govuk-one-login/service-header`、`yarn add @govuk-one-login/service-header`、`bun add @govuk-one-login/service-header`

## README

# 使用 GOV.UK One 登录服务的标题

GOV.UK One登录服务头是连接到GOV.UK One登录的政务服务的新导航组件.

它为用户提供了一个方法:

-   知道他们签了字
-   签名
-   更改证书中的标记

GOV.UK One登录页眉已改编自 [gOV.UK设计系统中的标准标题](https://design-system.service.gov.uk/components/header/)。 。 。 .

这是一个“beta”组件,我们有兴趣从服务团队那里听到它是如何与用户一起运行的.

服务使用时, 标题效果最好 [英国政府](https://frontend.design-system.service.gov.uk/)。 。 。 .

你们可以 [预览浏览器中的页眉](https://govuk-one-login.github.io/service-header/preview.html)。 。 。 .

![A screenshot of the GOV.UK One Login header. It has 2 sections: a blue section at the top showing the GOV.UK crown logo, a link saying "GOV.UK One Login", which takes you into your account, and a "Sign out" button. Below this section is a grey section, displaying the name of a government service and internal links within that service. Those just have placeholder text, so read "Service name" and "Service link 1" and so on. The black and grey sections are divided by a blue bar, like on the GOV.UK homepage.](https://npmcn.com/package/%40govuk-one-login/service-header/docs/assets/service-header.png)

注:截至2006年12月31日 [页:1](https://github.com/govuk-one-login/service-header/releases/tag/v3.1.0)根据更广泛的GOV.UK品牌刷新倡议,更新了服务头的设计.

## 如何为服务标题捐款

如果你是这个项目的开发者, 熟悉您的笔记 [此页面](https://npmcn.com/package/%40govuk-one-login/service-header/docs/dev-contribution-notes.md)。 。 。 .

## 联系维护者

跨政府黑:使用 [{\\fn黑体\\fs20\\shad2\\2ah82\\3ah20\\4ah33\\fscx95\\3ch592001\\be1}#govuk - one](https://ukgovernmentdigital.slack.com/archives/C02AQUJ6WTC) 频道

GDS内: 使用#di- one- login- home 频道

## 信头的不同部分做什么

该页头以前载有两个不同的导航菜单 -- -- 一个是GOV。 一个登录链接和一个内部服务导航链接,使用设计系统 [服务导航部分](https://design-system.service.gov.uk/components/service-navigation/)。 。 。 .

截至服务头版6.0.0,服务导航与主GOV.UK One Login头已脱钩.

您需要添加设计系统 [服务导航部分](https://design-system.service.gov.uk/components/service-navigation/) 单独(包括它的 CSS 和 Javascript),并对其进行调整,以包含特定内容.

### 英国政府 在信头中有一个登录链接

标题包含两个链接:

-   "GOV.UK One Login":这让用户进入他们的"One Login""home"区域,在那里他们可以管理自己的证书,并查看和访问他们使用过的服务——你不需要更新url这个指向
-   “ 签名” : 您需要调整此链接, 以便它将用户从您的服务中签出并把它们签出 One 登录 - 您如何这样做将取决于您如何在您的服务中执行的签名功能

## 如何在原型 Kit 原型中使用标题

关于如何在您的原型 Kit 工程中安装信头的说明 [这里](https://npmcn.com/package/%40govuk-one-login/service-header/docs/prototype-kit-installation.md)。 。 。 .

## 如何在服务中开始使用标题

### 如果你的服务不使用 Nunjucks

如果您的服务不使用 Nunjucks, 下载并解开最近附着的源代码 [释放](https://github.com/govuk-one-login/service-header/releases)。相关文件见 `dist` 文件夹.

### 如果你的服务使用 Nunjucks

> 如果您的服务使用 Nunjucks, 您可以使用国家防范机制安装信头
> 
> ```sh
> npm install @govuk-one-login/service-header
> ```
> 
> 或从标签中安装特定版本
> 
> ```sh
> npm install @govuk-one-login/service-header@6.0.0
> ```
> 
> 然后直接导入 Nunjucks 宏 `/service-header/service-header.njk`。以下的一些指示对于您来说似乎是多余的.

### 技术概览

该套件包含:

-   GOV.UK 1登录服务头部分的Nunjucks
-   页眉的平面 HTML - 这是从 Nunjucks 编译成 `/dist/html` 目录
-   用于编译 CSS 文件以给标题样式的 Sass 文件
-   plain CSS,用于不使用 Sass 的服务
-   a Javascript 文件, 允许 GOV. UK One 登录并在小屏幕上签名链接“ 放下” 行为

您需要从设计系统( 或 GOV. UK Frontend) 导入服务导航组件 。 遵循服务导航部分的指南 [文档页面](https://design-system.service.gov.uk/components/service-navigation/)。 。 。 .

您需要额外修改您的服务和头码, 以便它正确运行 .

你们需要:

-   在服务中写入逻辑, 以便只向签名的用户显示信头
-   调整信头的 HTML , 使其在您服务使用的温和语言中发挥作用( 如果您服务不使用 Nunjucks )
-   调整服务导航 HTML ,使其包括特定内容
-   将“ 标出” 链接标出您的服务端点
-   包含您服务中的样式文件和 Javascript 文件

### 在服务中写入逻辑, 以便只向签名的用户显示信头

标题只应在用户签名时显示 。 目前还没有 " 已签出州 " 版头.

您需要构建逻辑, 只显示信头在您服务的用户中签名 .

### 调整信头的 HTML , 使其在您服务使用的温和语言中发挥作用

标题的代码目前可用HTML和Nunjucks调试语言提供. 您需要修改 HTML 或 Nunjucks , 以适应您服务所使用的调试语言 .

Nunjucks的代码将会与 [GOV.UK 原型 Kit](https://prototype-kit.service.gov.uk/docs/),它使用Nunjucks作为其诱发语言.

[联系GOV.UK One登录组](https://npmcn.com/package/%40govuk-one-login/service-header/#readme-contact) 如果您想分享您在这个存储库的 诱导性执行,供其他团队使用.

### 调整内部服务导航 HTML 使其包括特定内容

您需要调整服务导航组件,以便:

-   显示当前用户在菜单中的哪一页
-   确保屏幕阅读器文本和 ARIA 属性符合您的服务

### Nunjucks 宏观执行

在服务头 6.0.0 之前,服务导航被整合到 `govukOneLoginServiceHeader`数字 :

#### (折旧)之前

```

{{ govukOneLoginServiceHeader({
  signOutLink: "/placeholder", 
  serviceNavigationParams: { 
    navigation: navigation, 
    serviceName: serviceName, 
    navigationLabel: "Test" 
}}) } } 
```

截至服务标题6.0.0 `govukOneLoginServiceHeader` 财务报告和审定财务报表 `govukServiceNavigation` 已经脱钩。 请作出修改,将其单独列入下文。 请注意,您必须指定 `serviceName`。 。 。 .

#### 之后

```

{{ govukOneLoginServiceHeader({
  signOutLink: "/placeholder"}) } }

{{ govukServiceNavigation({
  serviceName: "Service name",
  serviceUrl: "#",
  navigation: [
    {
      href: "#",
      text: "Navigation item 1"
    },
    {
      href: "#",
      text: "Navigation item 2",
      active: true
    },
    {
      href: "#",
      text: "Navigation item 3"
  }] }) } } 
```

### 无障碍考虑

#### 编辑屏幕阅读器文本和 ARIA 属性以指定您服务

如果您的服务包含服务导航组件, 您可能需要编辑标记( 或将相关参数传送到 Nunjucks 宏) :

-   菜单按钮
-   服务导航
-   页面用户正在服务导航中

参见设计系统处导航部分 [文档页面](https://design-system.service.gov.uk/components/service-navigation/) 用于指导.

#### 编辑“菜单”按钮的无障碍标记

遵循设计系统指南,为服务导航组件菜单按钮自定义标签.

#### 编辑内部服务导航菜单的无障碍标记

服务导航菜单包含链接来帮助用户导航您的服务. 它不同于允许用户访问“一个登录”并签名的“一个登录”导航菜单.

如果您的服务包含服务导航, 您需要修改屏幕阅读器文本 `aria-label` 服务导航的属性 `<nav>` 键.

这是帮助用户了解他们使用的导航菜单. 它还有助于满足世界导航咨询小组的要求,即导航地标必须贴有标签,如果有一个以上 `nav` 在页面上的元素,用于描述可能使用地标浏览网站的用户的导航.

### 在您的服务中标出“ 签出” 链接

GOV.UK One登录页头包含一个“签署”链接。 您需要更新此功能, 这样它就可以调用您的服务端点来签名用户出局 .

有关于如何将用户签出的文件 [英国政府 1个登录技术文件](https://docs.sign-in.service.gov.uk/integrate-with-integration-environment/managing-your-users-sessions/#log-your-user-out-of-gov-uk-one-login)它涉及如何:

-   请求在用户从 One 登录签名后重定向到您的服务
-   订阅 " 后通道登录 " 通知

如果您的服务使用带有 POST 请求的表单将用户签名出局,则可以在其中看到一个使用符号出局表而不是链接的服务头的例子 [页眉预览页](https://govuk-one-login.github.io/service-header/preview.html)。 。 。 .

## 在您服务中使用标题的样式

您如何使用标题的样式取决于您是否:

-   在您的服务中使用 GOV. UK 前端 npm 软件包
-   使用 GOV.UK 前端预编译的 CSS 服务文件
-   不使用 GOV.UK 前端

### 如果你用GOV的话 UK 前端 npm 软件包

从此仓库复制 Sass 文件到您的服务 Sass 执行 .

确定您已经添加 `node_modules` 敬你的萨斯道 此页眉代码用于 [简化其 Sass 导入路径](https://frontend.design-system.service.gov.uk/importing-css-assets-and-javascript/#simplify-sass-import-paths)。 。 。 .

如果您直接从服务头 npm 包导入服务头样式, 从服务头 v7 开始, 您应该能够使用 `pkg:` URL 以缩短 SAS URL 这样 `@use "pkg:@govuk-one-login/service-header"`。 。 。 .

您需要添加 [节点包导入器](https://sass-lang.com/documentation/js-api/classes/nodepackageimporter/#md:writing-sass-packages) ,或指定 `--pkg-importer=node` 如果您使用 Sass CLI 来编译您的风格 .

如果无法使用 `pkg:` URL, 您可以导入服务头样式为 `@use "@govuk-one-login/service-header"` (如果你使用捆绑器)或 `@use "@govuk-one-login/service-header/dist/styles/service-header"` (如果您不使用捆绑器 — 注意请添加) `node_modules` 进入你的萨斯负载路径.

### 如果您使用 GOV. UK 前端预编译的 CSS 文件

复制预编译的 CSS 文件( C)`dist/styles/service-header.css`)从包入到服务预编译的CSS.

预编译的CSS文件重复了GOV.UK前端CSS文件中的一些代码. 标题仍然会正确样式, 但是您的 CSS 文件会比需要的要大一些 .

### 如果您不使用 GOV.UK 前端

复制预编译的 CSS 文件( C)`dist/styles/service-header.css`从这个寄存器进入您服务的CSS.

预编译的 CSS 文件包含所有您需要样式标题的 CSS .

## 使用 GDS 传输字体

如果您的服务在服务上, 您必须使用带有页眉的 GDS 运输字体. gov.uk subdomain .

然而,这个寄存器不包括GDS Transport字体. 您需要使用 GOV. UK 前端单独安装 .

有个 [关于使用GDS Transport的更多信息](https://design-system.service.gov.uk/styles/typography/) 在GOV.UK设计系统.

## 使用页眉的 Javascript 文件

GOV.UK One登录服务头头使用Javascript来启用小屏幕大小上头头头的"下放"行为. 标题不依赖Javascript来做其他事.

从此软件包的 Javascript 文件中复制代码 ()`dist/scripts`)进入您服务的Javascript执行.

您只需要一个文件 :

-   `service-header.js` 包含JS对标题的要求,但将初始化留给您。 这样,如果需要的话,您可以先运行其他 Javascript 功能,然后再初始化标题下拉功能 .
-   `init-service-header.js` 自动启用标题组件。 您只需要包含此文件

根据您的需要选择其中之一 .

建议是导入 `service-header.js` 并运行初始化函数,在代码中的某个点,它才有意义.

### 初始化信头

如果您选择使用 `service-header.js`,您需要导入 `initCrossServiceHeader` 函数从文件运行 `initCrossServiceHeader()` 在你的代码.

使用 `service-header.js` 可见于 [页眉预览页](https://govuk-one-login.github.io/service-header/preview.html)。 。 。 .

### 如果您不使用页眉的 Javascript

在没有Javascript的情况下(例如,如果用户已经关闭了Javascript,或者代码没有加载),标题会优雅地降解. 没有 Javascript :

-   导航菜单将处于“ 已放下” 状态
-   菜单切换按钮不会显示( 如果没有 Javascript , 它将无法运行)

## 将标题内容翻译成其他语言

Nunjucks 用户应该能够通过指定来实施头条的威尔士版本 `lng: cy` 在组件选项中。 威尔士语版的"Sign out"链接应读作"Allgofnodi",而通向GOV.UK One Login Home 区域的链接应有一个 `?lng=cy` 查询字符串参数.

依赖将信头HTML复制到服务中的用户,应当执行逻辑来更新其服务威尔士版"Allogofnodi"的出站链接.

## 常见问题

### @govuk-one-login/service-header 是什么？

使用 GOV\.UK One 登录服务的标题

### 如何安装 @govuk-one-login/service-header？

在项目目录运行 npm install @govuk-one-login/service-header，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：govuk-frontend（^6\.5\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @govuk-one-login/service-header 支持 TypeScript 吗？

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

### @govuk-one-login/service-header 支持 ESM 还是 CommonJS？

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

### @govuk-one-login/service-header 可以商用吗？

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

### @govuk-one-login/service-header 的下载量有多少？

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

### @govuk-one-login/service-header 还在维护吗？

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

