UI Components
UI Components (ui-components) is a reusable component library. It provides the core components for the Cockroach design system.
npm install --save-dev @cockroachlabs/ui-components
Components are exported individually from the package,
import { Badge } from "@cockroachlabs/ui-components";
export default props => (
<div>
<Badge>Cockroach UI Badge</Badge>
</div>
);
Storybook
This library uses Storybook to document it's components.
To run storybook:
pnpm storybook
This will open storybook at http://localhost:6006/. From there, you can browse the library of shared components, as well as brand colors and typography.
关于 @cockroachlabs/ui-components 的常见问题@cockroachlabs/ui-components 是什么? UI Components is a reusable component library. It provides the core components for the Cockroach design system.
如何安装 @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 和提交记录判断。