GitLab 用户界面
GitLab UI 是一个执行 UI 组件库 帕贾马斯我们 设计系统。 GitLab 用户界面以 Vue.js (英语) 其目标是:
- 创建可重复使用的UI组件来加速前端开发.
- 为 GitLab 内的所有组件创建 UI 一致性 .
见 https://dedesign.gitlab.com/史地书 用于文档.
使用量
-
要在您的工程中使用 GitLab UI, 请添加为依赖 :
yarn add @gitlab/ui说明: 确保同时安装 GitLab UI 的对等依赖性 。 参见
package.json用于对等关系依赖及其预期版本的列表. -
在主入口处 在此之前 导入或使用任何组件:
import setConfigs from '@gitlab/ui/dist/config'; setConfigs();这将设置 GitLab UI 所使用的全局配置 .
-
在应用程序中包含所需的样式表 。 参见 CSS 文档 页:1 安装选项.
-
按要求导入组件 :
import { GlButton } from '@gitlab/ui';说明: GitLab UI 兼容树摇动, 您可以在您的工程中启用此功能 减少捆绑大小.
快速启动 - 开发
说明: GitLab UI不是设计在Windows本土上建造的. 无论是 WSL 维基月球 或者说 GitPod 图像 可用于设置 类似UNIX的环境来建造它.
填写 项目设置 在寄存器根 README 中,然后 建立和发布故事书:
cd packages/gitlab-ui
yarn storybook
转到 http://localhost:9001/ (英语)
测试
单位测试
组件单位测试在 tests/components测试按以下顺序进行:
用于组织组件的目录结构.
-
yarn test:unit运行所有单位测试. -
yarn test:unit:watch在监视模式下运行所有单元测试. -
yarn test:unit:debug运行所有单元测试,并允许在测试跑道过程中附加调试器. -
yarn jest [name_pattern]运行符合指定名称模式的 spec 文件.
实例
-
yarn jest datepicker将所有 spec 文件匹配到包含单词的名称 选取日期。 。 。 . -
yarn jest datepicker -t "when draw event is emitted"更远一步,只进行测试 带有一个符合向t旗帜.
SCSS测试
尽管我们尽量避免写复杂的SASS代码来维持CSS的复杂程度
执行了一些从自动化测试中受益的功能。 SASS测试现场直播 tests/scss
目录。 GitLab 用户界面 真实的 实施这些测试
开玩笑的.
yarn jest run_scss_tests 运行所有SCSS测试.
视觉回归测试
GitLab UI 使用视觉快照测试来防止带 CSS 和 组件的布局变化。 更多关于这一点,请在 视觉测试文件。 。 。 .
GitLab 视觉回归测试
GitLab UI 组件是参考执行 睡衣设计系统组件。这些组成部分 设计系统规格应当与设计系统规格相一致,在睡衣网站和 gitLab产品。 请看 用 GitLab 产品 CSS 调试 GitLab UI 发行 用于 GitLab 产品 CSS 的调试问题.
结束测试
结束测试的组件在 cypress/e2e 文件夹。 看我们的
结束测试文档 更多细节.
yarn run cypress open 运行 Cypress 本地端以运行结束测试 .
设计符号
GitLab UI使用设计符号来维持一个单一的真理源,通过自动化, 可用于不同的用途。 更多关于这一点,请在 设计符号文档。 。 。 .
释放
见 更新 GitLab 用户界面软件包 如何使用
@gitlab/ui 在各种项目中不断更新软件包.
要出版GitLab UI的新版本,请参看 出版软件包。 。 。 .
贡献指南
请审查 设计系统贡献过程 如何为帕贾马斯做出贡献.
关于GitLab UI的具体细节,参见 向GitLab UI捐款 页:1 增加资源和指南.
问题
有问题吗? 看看我们 财务问题你也许能找到答案.