# @forgebook/react 中文文档

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

版本：0\.1\.7
npm 元数据更新时间：2026-11-01T01:45:13.443Z
中文译文更新时间：2026-11-01T04:57:35.299Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：90.3 kB，43 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.18
- 运行依赖：3 个
- peer 依赖：react ^18\.2\.0 \|\| ^19\.0\.0，forgebook ^0\.1\.7，react-dom ^18\.2\.0 \|\| ^19\.0\.0
- 首次发布：2026-10-31T02:08:11.738Z
- 最新版本发布：2026-11-01T01:45:13.137Z
- 已发布版本数：8（近 12 个月 8 个）

## 中文简介

用于React的Forgebook：故事类型和钩子，框架装载故事时使用的渲染器，以及读取React组件道具的适配器。

## 安装

```sh
npm install @forgebook/react
```

也可以使用：`pnpm add @forgebook/react`、`yarn add @forgebook/react`、`bun add @forgebook/react`

## README

# @forgebook /反应

反应为 [Forgebook](https://www.npmjs.com/package/forgebook)：故事类型，渲染器，帧装入故事 以及从TypeScript类型中读取React组件的props的适配器。

**要求:** React 18.2或19· `forgebook` ····· [麻省理工学院的许可证](https://github.com/ensiria/forgebook/blob/develop/packages/react/LICENSE)

```sh
npm install --save-dev forgebook @forgebook/react
```

目录的配置将其命名为框架：

```ts
// forgebook.config.ts
import { react } from "@forgebook/react/vite";
import { defineConfig } from "forgebook";

export default defineConfig({ framework: react(), title: "My components", stories: ["src/**/*.stories.tsx"] });
```

故事的类型也来源于此：

```tsx
import type { Meta, Story } from "@forgebook/react";

import { Badge } from "./Badge";

export default { title: "Components/Badge", component: Badge } satisfies Meta<typeof Badge>;

export const Default: Story<typeof Badge> = { args: { label: "New" } };
```

| 进口 | 它是什么？ |
| --- | --- |
| `@forgebook/react` | `Meta`， `Story`， `Decorator`， `Preview`： CSF 3类型的React，从组件的道具的参数 |
| `@forgebook/react/vite` | `react()`的框架适配器 `forgebook.config.ts` |
| `@forgebook/react/texts`， `@forgebook/react/clock` | 一个故事的文本在目录的语言，和故事时钟，作为钩子 |

其余的出口都是目录自己装载的。开始，目录的特点和它 命令: [Forgebook的自述](https://github.com/ensiria/forgebook/blob/develop/packages/forgebook/README.md).

## 常见问题

### @forgebook/react 是什么？

用于React的Forgebook：故事类型和钩子，框架装载故事时使用的渲染器，以及读取React组件道具的适配器。

### 如何安装 @forgebook/react？

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

### @forgebook/react 支持 TypeScript 吗？

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

### @forgebook/react 支持 ESM 还是 CommonJS？

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

### @forgebook/react 需要什么版本的 Node\.js？

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

### @forgebook/react 可以商用吗？

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

### @forgebook/react 还在维护吗？

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