健康设计系统
健康设计系统(HDS)是澳大利亚政府卫生、残疾和老龄部的一个设计系统,其顶部是澳大利亚卫生、残疾和老龄部 黄金设计系统。 。 。 .
样式指南
查看 样式指南 关于如何使用健康设计系统组件的文件.
样式指南使用 分形。 。 。 .
依赖关系
可选
这些已包括在 javascript 库 用于方便的文件夹.
禁用任何可选的库和相关功能,只需不包含库. 您可以在数据库的相关组件中查找关于每个库提供的功能的信息 样式指南。 。 。 .
安装
使用量
备选办法1:作为国家防范机制一揽子方案安装
HDS可以作为npm包被添加到一个项目中.
npm install @health.gov.au/health-design-system
您可以使用以下 cli 命令在项目中生成 HTML 版本的健康设计系统风格指南 。 样式指南将位于生成的 hds_style_guide 目录并可通过打开 ./style-guide/index.html 浏览器中的文件.
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 文件 构建 文件夹. 包含任何 库脚本。 。 。 .
备选办法3:建设自己
克隆人,git子模块或下载寄存器.
要求数 节点.js
使用 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). 样式指南是使用 分形。 。 。 . |
健康设计系统开发
激活基特预承诺钩.
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系统 古尔普 以创建 HDS CSS 和 JavaScript 资产的编译版本。 编译的文件将在 build/ 目录 :
npm run gulp
HDS 启动套件
setup.js是一个用于配置 HDS 启动器套件的文件. 它被用来为即时开发创造一个基础的分线结构. 有关HDS启动器套件的更多信息请访问: https://github.com/healthgovau/health-design-system-starter-kit 互联网档案馆的存檔,存档日期2013-12-21