# @contentstack/venus-components 中文文档

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

版本：3\.0\.6
npm 元数据更新时间：2026-10-12T09:35:55.098Z
中文译文更新时间：2026-11-10T16:51:42.122Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：49.8 MB，1489 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.19\.0 \<25\.0\.0
- 运行依赖：61 个
- peer 依赖：react ^16\.8\.6 \|\| ^17 \|\| ^18 \|\| ^19，react-dom ^16\.8\.6 \|\| ^17 \|\| ^18 \|\| ^19
- 首次发布：2021-10-25T05:25:08.825Z
- 最新版本发布：2026-10-12T09:35:54.899Z
- 近 30 天下载量：9374（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：23（近 12 个月 4 个）

## 中文简介

金星组件

## 安装

```sh
npm install @contentstack/venus-components
```

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

## README

# 内容ack 金星组件库

* * *

## 1\. 概览

**金星组件** is Contentack 的官方 React 组件库,提供了可再使用的UI组件的综合集合. 它作为Concesstack的UI-React应用程序的设计系统基础,可用于构建基于UI扩展和Concesstack的应用程序.

**关键特性 :**

-   100+生产准备反应组件
-   带有完整类型定义的脚本类型支持
-   用于一致性主题的设计符号系统
-   基于 SCSS 有自定义变量的样式
-   综合故事书文件
-   注重无障碍(WCAG AA标准)
-   状态组件的 Redux 集成
-   丰富的文本编辑器组件( 基于 Slate)
-   Formik 组合格式组件

* * *

## 2\. 技术堆栈

| 层 | 技术 |
| --- | --- |
| **语言** | 类型脚本 5.3.3 |
| **框架** | 反应 18.3.1 |
| **构成部分库** | 这是金星组件库本身 |
| **州管理层** | Redux 4.0.5 + 反应 Redux 7.2.1 |
| **路由器** | 反应路由器 DOM 5.2.0 |
| **测试** | Jest 27.5.1 + 反应测试库 10.4.9 |
| **代码质量** | ESLint 8.47.0 + Pretier 2.0.4 (中文(简体) ) |
| **组件文档** | 故事书 6.5.14 |
| **设计托肯斯** | 样式词典 2.10.1 |
| **样式** | SCSS/PostCSS + 设计托肯斯 |
| **表单** | 福尔米克 2.4.6 |
| **丰富的文本编辑器** | 名单0.77.2 |
| **HTTP 客户端** | 轴心1.8.4 |
| **处理日期** | 日期-fns 2.1.5.0 + 时间.js 2.29.1 |

* * *

## 3\. 开始

### 先决条件

-   **节点.js**: v18.0.0+或 v24.x (中文(简体) )
-   **无**: v8.19.3+ (中文(简体) )
-   **图形**: 最新版本
-   **反应**: 16.8.6+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

* * *

## 4\. 在你的项目中使用图书馆

### 消费者安装

```bash
$ npm i @contentstack/venus-components --save
```

### 导入和使用

```tsx
import '@contentstack/venus-components/build/main.css'
import { Button, Table, Modal } from '@contentstack/venus-components'

<Button buttonType="primary" onClick={() => console.log('Clicked!')}>Click Me</Button>
```

### 设计托肯斯

**消费者**数字 :

```js
import { TokenName } from '@contentstack/venus-components/build/variables.js'
@import '@contentstack/venus-components/build/variables.css'
```

* * *

## 5\. 解决问题

### 共同问题

**同伴依赖冲突**: 使用 `npm install --legacy-peer-deps` 或者说 `npm install --ignore-scripts --no-engine`

**节点.js 兼容性**:使用v18或v25. 切换为 `nvm install 22 && nvm use 22`

**OpenSSL 错误**: 已经通过 `NODE_OPTIONS='--openssl-legacy-provider'` 装入包裹

**模块出错**运行 `npm run clean-install`

## 常见问题

### @contentstack/venus-components 是什么？

金星组件

### 如何安装 @contentstack/venus-components？

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

### @contentstack/venus-components 支持 TypeScript 吗？

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

### @contentstack/venus-components 支持 ESM 还是 CommonJS？

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

### @contentstack/venus-components 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20\.19\.0 \<25\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @contentstack/venus-components 可以商用吗？

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

### @contentstack/venus-components 的下载量有多少？

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

### @contentstack/venus-components 还在维护吗？

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