# @gitlab/duo-ui 中文文档

规范地址：https://npmcn.com/package/%40gitlab/duo-ui/

版本：16\.9\.7
npm 元数据更新时间：2026-11-16T03:03:41.659Z
中文译文更新时间：2026-11-16T10:55:26.930Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40gitlab/duo-ui
原文对照：https://npmcn.com/package/%40gitlab/duo-ui/?lang=original
项目主页：https://gitlab.com/gitlab-org/duo-ui#readme
源码仓库：https://gitlab.com/gitlab-org/duo-ui

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

- 包体积（解压后）：2.4 MB，373 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：16 个
- peer 依赖：vue ^2\.7\.16，pikaday ^1\.8\.0，bootstrap \>=4\.5\.3 \<=4\.6\.2，dompurify \>=2\.5\.2 \<3\.0\.0 \|\| \>=3\.1\.2，@gitlab/ui \>=112\.3\.1，emoji-regex \>=10\.0\.0，tailwindcss ^3，@gitlab/svgs ^1\.116\.0 \|\| ^2\.0\.0 \|\| ^3\.0\.0，highlight\.js \>=11\.0\.0 \<12\.0\.0，@json-render/vue ^0\.19\.0，@json-render/core ^0\.19\.0
- 首次发布：2024-10-25T09:44:53.558Z
- 最新版本发布：2026-11-16T03:03:41.489Z
- 近 30 天下载量：232108（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：287（近 12 个月 126 个）

## 中文简介

Duo UI 组件

## 安装

```sh
npm install @gitlab/duo-ui
```

也可以使用：`pnpm add @gitlab/duo-ui`、`yarn add @gitlab/duo-ui`、`bun add @gitlab/duo-ui`

## README

# Duo UI (英语)

Duo UI是一个库,是所有Duo组件的所在地,它们由多个Host系统共享.

## 故事书

最新主要分支: [https://gitlab-org.gitlab.io/duo-ui/ 页面存档备份,存于互联网档案馆](https://gitlab-org.gitlab.io/duo-ui/)

## 使用量

1.  要在您的工程中使用 Duo UI, 请添加为依赖 :
    
    ```sh
    yarn add @gitlab/duo-ui
    ```
    
    > **说明:** 确保同时安装 Duo UI 的对等依赖性 。 参见 [`package.json`](https://npmcn.com/package/%40gitlab/duo-ui/package.json) 用于对等关系依赖及其预期版本的列表.
    

## 快速启动 - 开发

**说明:** Duo UI不是设计在Windows本土上建造的. 无论是 [WSL 维基月球](https://learn.microsoft.com/en-us/windows/wsl/) 或者说 [GitPod 图像](https://www.gitpod.io/docs/configure/authentication/gitlab) 可用于设置 类似UNIX的环境来建造它.

确保你有 [节点](https://nodejs.org/en/) 16.x(LTS)和 [雅伦](https://yarnpkg.com/) 1.22 联合国 或更新.

```sh
# Clone the project
git clone git@gitlab.com:gitlab-org/duo-ui.git

# Navigate to the root of the project
cd duo-ui

# Install all the dependencies of the project
yarn # or yarn install

# Build and launch storybook to see the components in the browser
yarn storybook
```

转到 [http://localhost:9001/ (英语)](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` 旗帜.
    

### 视觉回归测试

Duo UI 使用可视快照测试来防止带 CSS 和 组件的布局变化。 更多关于这一点,请在 [视觉测试文件](https://npmcn.com/package/%40gitlab/duo-ui/doc/contributing/visual_testing.md)。 。 。 .

## 释放

见 [更新 Duo UI 软件包](https://npmcn.com/package/%40gitlab/duo-ui/doc/updating-duo-ui-packages.md) 如何使用 `@gitlab/duo-ui` 在各种项目中不断更新软件包.

## 贡献指南

请参考 [捐款额](https://npmcn.com/package/%40gitlab/duo-ui/CONTRIBUTING.md) 详细介绍如何添加新的组件和 普遍向Duo UI捐款.

### 问题

有问题吗? 看看我们 [财务问题](https://npmcn.com/package/%40gitlab/duo-ui/FAQ.md)你也许能找到答案.

## 常见问题

### @gitlab/duo-ui 是什么？

Duo UI 组件

### 如何安装 @gitlab/duo-ui？

在项目目录运行 npm install @gitlab/duo-ui，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：vue（^2\.7\.16）、pikaday（^1\.8\.0）、bootstrap（\>=4\.5\.3 \<=4\.6\.2）、dompurify（\>=2\.5\.2 \<3\.0\.0 \|\| \>=3\.1\.2）、@gitlab/ui（\>=112\.3\.1）、emoji-regex（\>=10\.0\.0）、tailwindcss（^3）、@gitlab/svgs（^1\.116\.0 \|\| ^2\.0\.0 \|\| ^3\.0\.0）、highlight\.js（\>=11\.0\.0 \<12\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @gitlab/duo-ui 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @gitlab/duo-ui 支持 ESM 还是 CommonJS？

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

### @gitlab/duo-ui 可以商用吗？

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

### @gitlab/duo-ui 的下载量有多少？

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

### @gitlab/duo-ui 还在维护吗？

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

