# @cockroachlabs/ui-components 中文文档

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

版本：1\.15\.24
npm 元数据更新时间：2026-11-03T12:21:59.481Z
中文译文更新时间：2026-11-10T05:10:17.490Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：8.5 MB，155 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：11 个
- peer 依赖：antd ^5\.20\.3，react ^18\.3\.1，react-dom ^18\.3\.1，react-router-dom ^6\.0\.0
- 首次发布：2020-02-07T21:21:27.360Z
- 最新版本发布：2026-06-23T20:49:32.759Z
- 近 30 天下载量：8098（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：1722（近 12 个月 4 个）

## 中文简介

UI组件是一个可再用组件库. 它为Cockroach设计系统提供了核心组件.

## 安装

```sh
npm install @cockroachlabs/ui-components
```

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

## README

# UI 组件

UI 组件`ui-components`)是一个可重复使用的组件库。 它为Cockroach设计系统提供了核心组件.

```
  npm install --save-dev @cockroachlabs/ui-components
```

从包件中单独出口部件,

```javascript
import { Badge } from "@cockroachlabs/ui-components";

export default props => (
  <div>
    <Badge>Cockroach UI Badge</Badge>
  </div>
);
```

## 故事书

这个图书馆使用"故事书"来记录它的组件.

运行故事本:

```
pnpm storybook
```

这将打开故事书 在 `http://localhost:6006/`。从那里可以浏览共享组件的库,以及品牌颜色和打字.

## 常见问题

### @cockroachlabs/ui-components 是什么？

UI组件是一个可再用组件库\. 它为Cockroach设计系统提供了核心组件\.

### 如何安装 @cockroachlabs/ui-components？

在项目目录运行 npm install @cockroachlabs/ui-components，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：antd（^5\.20\.3）、react（^18\.3\.1）、react-dom（^18\.3\.1）、react-router-dom（^6\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @cockroachlabs/ui-components 支持 TypeScript 吗？

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

### @cockroachlabs/ui-components 支持 ESM 还是 CommonJS？

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

### @cockroachlabs/ui-components 可以商用吗？

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

### @cockroachlabs/ui-components 的下载量有多少？

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

### @cockroachlabs/ui-components 还在维护吗？

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