@forgebook/react

中文文档
0.1.7发布于 2026/11/01MITTypeScriptES Module构建来源已验证

Forgebook for React: the story types and hooks, the renderer the frame mounts a story with, and the adapter that reads a React component's props.

原始使用文档

@forgebook/react

React for Forgebook: the story types, the renderer the frame mounts a story with, and the adapter that reads a React component's props from its TypeScript types.

Requirements: React 18.2 or 19 · forgebook · Vite 8 · MIT licence

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

The catalogue's configuration names it as its framework:

// 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"] });

and the stories take their types from it:

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" } };
ImportWhat it is
@forgebook/reactMeta, Story, Decorator, Preview: CSF 3 typed for React, the args from the component's props
@forgebook/react/vitereact(), the framework adapter of forgebook.config.ts
@forgebook/react/texts, @forgebook/react/clockA story's texts in the catalogue's language, and the story clock, as hooks

The rest of its exports are what the catalogue loads itself. Getting started, the catalogue's features and its commands: Forgebook's README.

版本与发布记录

@forgebook/react 共发布 8 个版本,首次发布于 2026/10/31;过去 12 个月发布了 8 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.1.7latest2026/11/012 天前
0.1.62026/11/012 天前
0.1.52026/11/012 天前
0.1.42026/11/012 天前
0.1.32026/10/312 天前
0.1.22026/10/313 天前

关于 @forgebook/react 的常见问题

@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 和提交记录判断。