# @codaco/ui 中文文档

规范地址：https://npmcn.com/package/%40codaco/ui/

版本：5\.8\.6
npm 元数据更新时间：2025-05-06T17:57:50.594Z
中文译文更新时间：2026-11-10T06:05:22.730Z
软件包许可：GPL-3\.0-or-later

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

原始 npm 页面：https://www.npmjs.com/package/%40codaco/ui
原文对照：https://npmcn.com/package/%40codaco/ui/?lang=original

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

- 包体积（解压后）：2.4 MB，693 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：12\.14\.1
- 运行依赖：28 个
- peer 依赖：react ^16\.13\.1，react-dom ^16\.13\.1
- 首次发布：2020-01-07T13:09:00.759Z
- 最新版本发布：2025-05-06T17:57:50.394Z
- 近 30 天下载量：6342（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：133（近 12 个月 0 个）

## 中文简介

网络 Canvas 项目的样式和反应组件

## 安装

```sh
npm install @codaco/ui
```

也可以使用：`pnpm add @codaco/ui`、`yarn add @codaco/ui`、`bun add @codaco/ui`

## README

# 网络相机

## 安装

安装 npm 或连接到 git in package.json :

```sh
npm install --save @codaco/ui
```

```js
// in package.json
{
  "dependencies": {
    "@codaco/ui": "git+https://git@github.com/complexdatacollective/Network-Canvas-UI.git"
  }
}
```

## 部署

这是 npmjs 上的 Org 软件包 .

1.  更新软件包中的版本编号。 json
2.  `npm run publish`

## 开发(使用故事书)

运行 : `npm run storybook`

浏览器窗口将打开,可实时浏览组件.

这是一个新的特性,因此并非所有组件都定义.

## 开发(使用网络电视)

```sh
# In UI
$ npm link

# In consuming app
$ npm link @codaco/ui

# After each change (in UI):
$ npm install
$ npm run build
$ npm install --only=production # potentially also rm -rf node_modules
```

恢复消费应用: `npm install`

### 构成部分

```jsx
// in LocalComponent.js

import { ExampleComponent } from '@codaco/ui';

// To directly link to a component use:
// `import ComponentName from '@codaco/ui/lib/components/ComponentName'`;

const LocalComponent = props => (
  <div className="local-component">
    <ExampleComponent />
  </div>
);
```

### 样式

您可以在主样式表中包含所有样式 :

```scss
// in main.scss
@import '~@codaco/ui/lib/styles/all';
```

只有某些组件的导入样式可能可行,但目前不支持.

### 图标

### 颜色

要添加新的颜色或调色板,您可以在根选择器中添加一个新的 Css 变量 :

```SASS
:root {
  --my-new-color: blue;
}
```

## 包括什么

### 构成部分列表

-   组件列表如下.

## 版本

这个项目使用 [语义版本](http://semver.org/)数字 :

`AA.BB.CC`

-   当您做出不兼容的 API 更改时 AA 版本,
-   当您以反相兼容的方式添加功能时, BB 版本,以及
-   CC 版本,当您进行反向兼容错误修正时 .

## 常见问题

### @codaco/ui 是什么？

网络 Canvas 项目的样式和反应组件

### 如何安装 @codaco/ui？

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

### @codaco/ui 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/codaco\_\_ui 是否存在。

### @codaco/ui 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @codaco/ui 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js 12\.14\.1。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @codaco/ui 可以商用吗？

@codaco/ui 使用 GPL-3\.0-or-later 许可。强 Copyleft：分发包含该代码的软件时，整个作品需以 GPL-3\.0 兼容许可开源，并附带专利与反锁定条款。仅内部使用不触发此义务。以上为概括，不构成法律意见，请以许可原文为准。

### @codaco/ui 的下载量有多少？

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

### @codaco/ui 还在维护吗？

最新版本 5\.8\.6 发布于 2025/05/07（1\.5 年前）；至今共发布 133 个版本，其中过去 12 个月发布了 0 个；首次发布于 2020/01/07。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。