# @pxsig/storybook-addon 中文文档

规范地址：https://npmcn.com/package/%40pxsig/storybook-addon/

版本：0\.7\.3
npm 元数据更新时间：2026-11-02T03:50:47.268Z
中文译文更新时间：2026-11-02T06:47:59.129Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：33.6 kB，8 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：\>=22
- 运行依赖：0 个
- peer 依赖：storybook \>=10
- 首次发布：2026-10-19T05:45:17.346Z
- 最新版本发布：2026-11-02T03:50:46.851Z
- 已发布版本数：16（近 12 个月 16 个）

## 中文简介

故事书中的pxsig：一个视觉回归面板和侧边栏状态，由pxsig服务器提供；在已部署的Storybook上，一个只读快照。

## 安装

```sh
npm install @pxsig/storybook-addon
```

也可以使用：`pnpm add @pxsig/storybook-addon`、`yarn add @pxsig/storybook-addon`、`bun add @pxsig/storybook-addon`

## README

# @pxsig / storybook-addon

一个“pxsig：视觉回归”面板，带有当前的检查器 在侧边栏的每个故事上都有一个状态点。它是pxsig服务器的客户机；开始 它与 `npx pxsig serve --watch`.

```bash
npm install -D @pxsig/storybook-addon
```

`.storybook/main.ts`：

```ts
const config = {
  addons: ['@pxsig/storybook-addon'],
  // or: [{ name: '@pxsig/storybook-addon', options: { server: 'http://127.0.0.1:6070' } }]
};
export default config;
```

插件自己查找服务器 `server` 选项，否则为正在运行的服务器的地址 为工作空间编写，否则工作空间的配置端口，否则 `http://127.0.0.1:6070`.

在部署在其他地方（dev、UAT、pre-prod）的Storybook上，该插件不会向任何pxsig发出请求 服务器：其面板显示只读快照 `storybook build` 写入到构建中 （`pxsig-snapshot.json`;选项 `snapshot: false` 把它去掉)。

需要Storybook 10或更高版本（在10.6上测试）。进口 `storybook/manager-api` 和 `storybook/internal/components`，并通过Storybook的状态存储报告侧边栏状态 （`experimental_getStatusStore`）; 这些在故事书8中都不存在。故事书9有，但是没有 未测试，所以对等体范围从10开始。

完整的文档: [文档/ storybook.md](https://github.com/hydrotik/pxsig/blob/v0.7.3/docs/storybook.md).

麻省理工学院。版权所有2026 Hydrotik LLC

## 常见问题

### @pxsig/storybook-addon 是什么？

故事书中的pxsig：一个视觉回归面板和侧边栏状态，由pxsig服务器提供；在已部署的Storybook上，一个只读快照。

### 如何安装 @pxsig/storybook-addon？

在项目目录运行 npm install @pxsig/storybook-addon，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：storybook（\>=10）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @pxsig/storybook-addon 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/pxsig\_\_storybook-addon 是否存在。

### @pxsig/storybook-addon 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @pxsig/storybook-addon 需要什么版本的 Node\.js？

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

### @pxsig/storybook-addon 可以商用吗？

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

### @pxsig/storybook-addon 还在维护吗？

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