# @erxes/ui 中文文档

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

版本：3\.4\.22
npm 元数据更新时间：2026-11-13T15:58:54.689Z
中文译文更新时间：2026-11-14T00:58:53.618Z
软件包许可：AGPL-3\.0-only

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

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

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

- 包体积（解压后）：2.8 MB，1050 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：55 个
- peer 依赖：jotai ^2\.12\.0，react ^18\.3\.1，graphql ^16\.10\.0，react-dom ^18\.3\.1，react-i18next ^15\.1\.1，@apollo/client ^3\.11\.8，react-router-dom ^7\.1\.1
- 首次发布：2026-10-12T09:27:39.294Z
- 最新版本发布：2026-11-13T15:58:54.251Z
- 近 30 天下载量：2638（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：61（近 12 个月 61 个）

## 中文简介

erxes设计系统:UI原始,商业模块,钩子和共享前端状态

## 安装

```sh
npm install @erxes/ui
```

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

## README

# 厄克赛-伊

共享反应组件,商业模块,钩子,以及erxes的前端状态.

## 在反应应用程序中安装

```sh
npm install @erxes/ui
```

```tsx
import { Button } from '@erxes/ui';

export function Example() {
  return <Button onClick={() => window.alert('Hello')}>Continue</Button>;
}
```

已发布的软件包包含 JavaScript 并自动导入其编译 样式表。 维特源别名, `process.env` 嘘, 尾风插件, 来源 不需要扫描和复制主题声明来渲染组件. 匹配 React 版本与软件包的对等依赖 .

组件子路径还包括样式表:

```tsx
import { Button } from '@erxes/ui/components/button';
```

样式表覆盖了库使用的类. 配置您的尾风 应用程序,如果您想要生成您自己的额外工具类. 覆盖 CSS 等变量 `--primary` 自定义默认主题。 添加 页:1 `dark` 分类到父元素,以选择阴暗的主题.

样式表还设置了页面默认 erxes apps share(`src/base.css`: 默认的光和暗主题,每个元素的主题边框颜色,页面 背景和文本颜色,以及标题大小。 独立软件不是 由 core- ui 主机主机仅需要此样式表, 加上 `@erxes/ui/fonts.css` 要装入 Inter and Roboto Mono(核心-ui从它装入它们) `index.html`) (中文(简体) ).

`@erxes/ui/theme.css` 用于已编译的应用程序 尾风并供应自己的设计标志. 编译的样式表也是 导出为 `@erxes/ui/styles.css` 财务报告和审定财务报表 `@erxes/ui/style.css`。 。 。 .

仍然需要使用路由、图形QL、翻译或共享状态的组件 其相应的应用程序提供者。 即时使用样式表 不配置这些服务.

## 构建 npm 软件包

```sh
pnpm nx build erxes-ui
pnpm --filter erxes-ui test:package
pnpm --dir frontend/libs/erxes-ui/dist pack
```

这栋楼是独立的 `dist/package.json`, JavaScript 条目,类型 和汇编的CSS。 现有 `theme.css` 合同和违约 符号在 `src/base.css` (也由Core-ui导入)被编入其中. 发布工作流程包此 目录并应用共享平台版本. 工作场所消费者继续 解决原始源出口.

申报排放保留共享图书馆工作流程的现有政策: 类型诊断被报告,而声明失败使构建失败.

## 运行单元测试

运行 `nx test erxes-ui` 通过 [欢乐](https://jestjs.io/)。 。 。 .

## 常见问题

### @erxes/ui 是什么？

erxes设计系统:UI原始,商业模块,钩子和共享前端状态

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

在项目目录运行 npm install @erxes/ui，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：jotai（^2\.12\.0）、react（^18\.3\.1）、graphql（^16\.10\.0）、react-dom（^18\.3\.1）、react-i18next（^15\.1\.1）、@apollo/client（^3\.11\.8）、react-router-dom（^7\.1\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

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

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

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

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

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

@erxes/ui 使用 AGPL-3\.0-only 许可。最严格的 Copyleft：除分发外，通过网络向用户提供基于它的服务也需要开源对应源码。闭源 SaaS 使用前务必评估。以上为概括，不构成法律意见，请以许可原文为准。

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

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

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

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