# @health\.gov\.au/health-design-system 中文文档

规范地址：https://npmcn.com/package/%40health.gov.au/health-design-system/

版本：3\.3\.1
npm 元数据更新时间：2026-08-25T00:27:05.812Z
中文译文更新时间：2026-11-17T18:30:38.322Z
软件包许可：GNU GENERAL PUBLIC LICENSE v3

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

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

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

- 包体积（解压后）：110 MB，3703 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：\>=24\.x
- 运行依赖：3 个
- 首次发布：2019-11-29T01:48:27.678Z
- 最新版本发布：2026-08-25T00:27:05.651Z
- 近 30 天下载量：13958（2026-10-18 至 2026-11-16，npm 官方下载统计）
- 已发布版本数：44（近 12 个月 3 个）

## 中文简介

健康设计系统. gov.au及相关产品.

## 安装

```sh
npm install @health.gov.au/health-design-system
```

也可以使用：`pnpm add @health.gov.au/health-design-system`、`yarn add @health.gov.au/health-design-system`、`bun add @health.gov.au/health-design-system`

## README

# 健康设计系统

健康设计系统(HDS)是澳大利亚政府卫生、残疾和老龄部的一个设计系统,其顶部是澳大利亚卫生、残疾和老龄部 [黄金设计系统](https://gold.designsystemau.org/)。 。 。 .

## 样式指南

查看 [样式指南](https://healthgovau.github.io/health-design-system/) 关于如何使用健康设计系统组件的文件.

样式指南使用 [分形](https://github.com/frctl/fractal)。 。 。 .

## 依赖关系

-   [j 查询 v3+](https://jquery.com/)

### 可选

-   [j 查询用户界面自动完成](https://jqueryui.com/download/#!version=1.12.1&components=110000010001000000100000100000000000000000000000)
-   [懒惰](https://github.com/verlok/lazyload)
-   [花样框](http://fancyapps.com/fancybox/3/)
-   [TiJs](https://github.com/atomiks/tippyjs)

这些已包括在 [javascript 库](https://npmcn.com/package/%40health.gov.au/health-design-system/js/libraries) 用于方便的文件夹.

禁用任何可选的库和相关功能,只需不包含库. 您可以在数据库的相关组件中查找关于每个库提供的功能的信息 [样式指南](https://healthgovau.github.io/health-design-system/)。 。 。 .

## 安装

### 使用量

#### 备选办法1:作为国家防范机制一揽子方案安装

HDS可以作为npm包被添加到一个项目中.

```
npm install @health.gov.au/health-design-system
```

您可以使用以下 cli 命令在项目中生成 HTML 版本的健康设计系统风格指南 。 样式指南将位于生成的 `hds_style_guide` 目录并可通过打开 `./style-guide/index.html` 浏览器中的文件.

```sh
npx healthds build-guide
```

您可以使用 HDS 核心 sass 文件导入您的项目 `@import "@health.gov.au/health-design-system/source/sass/all"`假设 `node_modules` 目录包含在您 SAS 构建路径中.

JavaScript 源文件可用于 `@health.gov.au/health-design-system/health-design-system/source/js/src/`。 。 。 .

CSS和JavaScript资产的编译版本可见于 `@health.gov.au/health-design-system/build/css/` 财务报告和审定财务报表 `@health.gov.au/health-design-system/build/js/` 页:1.

#### 备选案文2:出框

简单的下载并包含 cm js 文件 [构建](https://npmcn.com/package/%40health.gov.au/health-design-system/build) 文件夹. 包含任何 [库脚本](https://npmcn.com/package/%40health.gov.au/health-design-system/build/js/libraries)。 。 。 .

#### 备选办法3:建设自己

克隆人,git子模块或下载寄存器.

要求数 [节点.js](https://nodejs.org/)

使用 Gulp 任务构建 :

`npm install` 然后运行 :

-   `npm run gulp`: 建立开发和制作备用CSS和联署文件.
-   `npm run gulp watch`:观察变化并重建.

或者你可以将核心的sass文件导入你的管道 `@import "health-design-system/source/sass/all.scss"`

来源javascript文件可用于 `health-design-system/source/js/src`。 。 。 .

## 命令行工具

如果您将 HDS 安装为 npm 软件包, 则可以使用命令行工具 .

| 命令 | 说明 |
| --- | --- |
| `npx healthsd build-guide` | 在当前的工作目录中生成一个静态 HDS 样式指南的 HTML 版本。 样式指南是在 `health-style-guide` 目录. |
| `npx healthsd help` | 显示命令使用信息. |

## 项目结构

以下是项目使用的重要目录的描述.

| 目录 | 说明 |
| --- | --- |
| `build/` | 已编译 CSS 和 JavaScript 文件. |
| `docs/` | 已编译 HDS 组件库的 HTML 版本(a. Style Guide). 指南可通过打开访问 `docs/index.html` 在浏览器中. |
| `node_modules/` | 国家防范机制增加的项目依赖性. |
| `source/js/` | JavaScript 源文件. 包括JavaScript库以及自定义代码. |
| `source/sass/` | SASS 源文件 |
| `source/sass/components/@gov.au/` | 由DTA设计系统提供的样式的覆被应放入此目录. 覆盖应被放入一个SASS部分文件,其名称与DTA设计系统中定义样式的文件相同. |
| `source/sass/components/@health/` | 用于自定义 HDS 组件的样式 。 这些部件不属于DTA设计系统. |
| `style-guide/` | HDS 组件库中包含组件的源模板和配置文件(aka. the Style Guide). 样式指南是使用 [分形](https://fractal.build/)。 。 。 . |

## 健康设计系统开发

激活基特预承诺钩.

```
npm start
```

安装依赖性 :

```
npm install
```

启动分形开发服务器 。 这将生成一个本地链接来查看样式指南 。 当修改组件源文件时,样式指南会被自动更新. 请注意, 要看到任何与 SAS 相关的样式更改, 您需要使用其中之一来编译任何 SAS 更改 `npm run gulp` 或者说 `npm run gulp:watch`。 。 。 .

```
npm run fractal:start
```

要构建一个静态HTML版本的"样式指南",使用以下命令. 构建样式指南后,可通过打开访问 `docs/index.html` 浏览器中的文件.

```
npm run fractal:build
```

使用HDS系统 [古尔普](https://gulpjs.com/) 以创建 HDS CSS 和 JavaScript 资产的编译版本。 编译的文件将在 `build/` 目录 :

```
npm run gulp
```

### HDS 启动套件

setup.js是一个用于配置 HDS 启动器套件的文件. 它被用来为即时开发创造一个基础的分线结构. 有关HDS启动器套件的更多信息请访问: [https://github.com/healthgovau/health-design-system-starter-kit 互联网档案馆的存檔,存档日期2013-12-21](https://github.com/healthgovau/health-design-system-starter-kit)

## 常见问题

### @health\.gov\.au/health-design-system 是什么？

健康设计系统\. gov\.au及相关产品\.

### 如何安装 @health\.gov\.au/health-design-system？

在项目目录运行 npm install @health\.gov\.au/health-design-system，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 healthds、hdssetup，可以用 npx healthds 直接运行。

### @health\.gov\.au/health-design-system 支持 TypeScript 吗？

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

### @health\.gov\.au/health-design-system 支持 ESM 还是 CommonJS？

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

### @health\.gov\.au/health-design-system 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=24\.x。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @health\.gov\.au/health-design-system 可以商用吗？

@health\.gov\.au/health-design-system 使用 GNU GENERAL PUBLIC LICENSE v3 许可。声明的许可为 GNU GENERAL PUBLIC LICENSE v3，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @health\.gov\.au/health-design-system 的下载量有多少？

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

### @health\.gov\.au/health-design-system 还在维护吗？

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

