# @edifice\.io/react 中文文档

规范地址：https://npmcn.com/package/%40edifice.io/react/

版本：2\.6\.14
npm 元数据更新时间：2026-11-13T15:05:25.590Z
中文译文更新时间：2026-11-13T15:06:53.395Z
软件包许可：AGPL-3\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40edifice.io/react
原文对照：https://npmcn.com/package/%40edifice.io/react/?lang=original
项目主页：https://github.com/edificeio/edifice-frontend-framework/tree/main/packages/react#readme
源码仓库：https://github.com/edificeio/edifice-frontend-framework

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

- 包体积（解压后）：1.9 MB，1937 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：59 个
- peer 依赖：react 18\.3\.1，react-dom 18\.3\.1，react-i18next 14\.1\.3，react-hook-form 7\.71\.1，@react-spring/web 9\.7\.5，@tanstack/react-query 5\.62\.7
- 首次发布：2024-09-19T15:31:21.052Z
- 最新版本发布：2026-11-13T15:05:24.450Z
- 近 30 天下载量：14725（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：1056（近 12 个月 601 个）

## 中文简介

Edifile 反应库

## 安装

```sh
npm install @edifice.io/react
```

也可以使用：`pnpm add @edifice.io/react`、`yarn add @edifice.io/react`、`bun add @edifice.io/react`

## README

# 立体反应组件

![npm](https://img.shields.io/npm/v/@edifice.io/react?style=flat-square) ![bundlephobia](https://img.shields.io/bundlephobia/min/@edifice.io/react?style=flat-square)

## 开始

我们跟着 [瓦伊·阿里亚](https://www.w3.org/WAI/ARIA/apg/patterns/) 规则和规则 [靴子陷阱 5](https://getbootstrap.com/docs/5.0/components/accordion/) 制作组件时的准则

### 构建

```bash
pnpm run build
```

### 林特

```bash
pnpm run lint
```

若为 `pnpm run lint` 显示问题,运行此命令以修正它们.

```bash
pnpm run fix
```

### 高级

```bash
pnpm run format
```

## 结构

### 组件文件夹

-   总是在 PascalCase 中的文件夹名 : `Button`
-   PascalCase中组件文件 : `Button.tsx`
-   导出组件文件内的类型和接口( I)
-   PascalCase + 中的故事文件 `*.stories.tsx` 数字 : `Button.stories.tsx`

```bash
src
  -- ComponentFolder
    -- Component.tsx
    -- Component.stories.tsx
    -- index.ts
```

-   将组件在自己内部再出口 `index` 文件 : `index.ts`
-   如果组件有类型和接口, 则导出全部内容( I)

```jsx
export { default as Component } from './Component';
export * from './Component';
```

### 构成部分 准则

-   总是用JSDoc格式记录组件的基本准则。 被"故事书"用来生成文档.

```jsx
/**
 * Primary UI component for user interaction
 */
```

### 界面说明

-   总是与 JSDoc 语法进行文档打字类型和接口. 被"故事书"用来生成文档.

```jsx
// Interface description (e.g: TreeViewProps.tsx)
export interface ButtonProps {
  /**
   * Is this the principal call to action on the page?
   */
  primary?: boolean;
  /**
   * What background color to use
   */
  backgroundColor?: string;
  /**
   * How large should the button be?
   */
  size?: "small" | "medium" | "large";
  /**
   * Button contents
   */
  label: string;
  /**
   * Optional click handler
   */
  onClick?: () => void;
}
```

### 内部索引文件 `src` 文件夹

-   此反应库的入口 .
-   在内部导入您的组件 `index.ts` 文档.

```jsx
export * from './Button';
```

## 添加图标

[https://edifile-community.atlassian.net/wiki/spaces/ODE/pages/4371611649/ Overview#Ajout-de-l%E2%-80%99ic%C3%B4ne](https://edifice-community.atlassian.net/wiki/spaces/ODE/pages/4371611649/Overview#Ajout-de-l%E2%80%99ic%C3%B4ne)

## 德维

您可以使用 `Storybook`。见 [读取](https://npmcn.com/package/docs//README.md)

## 常见问题

### @edifice\.io/react 是什么？

Edifile 反应库

### 如何安装 @edifice\.io/react？

在项目目录运行 npm install @edifice\.io/react，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（18\.3\.1）、react-dom（18\.3\.1）、react-i18next（14\.1\.3）、react-hook-form（7\.71\.1）、@react-spring/web（9\.7\.5）、@tanstack/react-query（5\.62\.7）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @edifice\.io/react 支持 TypeScript 吗？

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

### @edifice\.io/react 支持 ESM 还是 CommonJS？

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

### @edifice\.io/react 可以商用吗？

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

### @edifice\.io/react 的下载量有多少？

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

### @edifice\.io/react 还在维护吗？

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