# @canonical/storybook-addon-utils 中文文档

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

版本：0\.45\.0
npm 元数据更新时间：2026-10-23T01:44:06.039Z
中文译文更新时间：2026-11-09T01:31:02.676Z
软件包许可：LGPL-3\.0

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

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

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

- 包体积（解压后）：70.3 kB，55 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：react ^18\.0\.0 \|\| ^19\.0\.0，react-dom ^18\.0\.0 \|\| ^19\.0\.0，storybook ^10\.6\.0，@canonical/styles \>=0\.34\.0 \<1\.0\.0，@canonical/router-core \>=0\.34\.0 \<1\.0\.0，@canonical/router-react \>=0\.34\.0 \<1\.0\.0
- 首次发布：2026-04-01T01:23:17.795Z
- 最新版本发布：2026-10-23T01:44:05.667Z
- 近 30 天下载量：9542（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：27（近 12 个月 27 个）

## 中文简介

故事书加通:网格模式,颜色方案,基线网格,元素大纲

## 安装

```sh
npm install @canonical/storybook-addon-utils
```

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

## README

# @ canonical/ 故事本- addon- utils

调试和布局用于故事本的效用 。 添加用于网格包围、颜色方案、基线网格覆盖和元素大纲的工具栏控制.

## 安装

```bash
bun add -D @canonical/storybook-addon-utils
```

## 设置

将加词在您的 `.storybook/main.ts`数字 :

```typescript
const config: StorybookConfig = {
  addons: [
    "@canonical/storybook-addon-utils",
  ],
};

export default config;
```

## 工具栏控件

| 控制权 | 快捷键 | 数值 | 说明 |
| --- | --- | --- | --- |
| 网格模式 | `G` | \* 无 \* 内在 \* 反应 \* 展示 | 将故事卷入 `.grid` 集装箱(`showcase` = 被夹住,以高高的画布为中心柱) |
| 颜色方案 | `S` | 没有(系统) ——光 ——暗 | 切换 `.light`编号 :`.dark` 身体课 |
| 基线网格 | `B` | 打开/关闭 | 显示基线网格覆盖 |
| 大纲 | `O` | 打开/关闭 | 显示元素大纲覆盖 |

## 故事参数

故事和metas可以通过 `parameters`。工具栏覆盖总是优先.

```tsx
const meta = {
  parameters: {
    grid: "intrinsic",        // "none" | "intrinsic" | "responsive" | "showcase"
    scheme: "none",           // "none" | "light" | "dark"
    debug: {
      baseline: true,         // boolean
      outlines: false,        // boolean
    },
  },
} satisfies Meta;

// Story-level override
export const DarkMode: Story = {
  parameters: {
    scheme: "dark",
  },
};
```

## CSS 自定义属性

在您的预览样式中覆盖这些来自定义覆盖 :

| 财产 | 默认 | 说明 |
| --- | --- | --- |
| `--baseline-grid-color` | `rgba(255, 0, 0, 0.2)` | 基线网格线颜色 |
| `--baseline-height` | `0.5rem` | 基线网格间隔 |
| `--debug-outline-color` | `light-dark(rgba(0,128,80,0.25), rgba(80,220,140,0.25))` | 元素大纲颜色 |

## 所需资源

ES模块. 节点20+. 故事书10.3+.

## 常见问题

### @canonical/storybook-addon-utils 是什么？

故事书加通:网格模式,颜色方案,基线网格,元素大纲

### 如何安装 @canonical/storybook-addon-utils？

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

### @canonical/storybook-addon-utils 支持 TypeScript 吗？

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

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

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

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

@canonical/storybook-addon-utils 使用 LGPL-3\.0 许可。弱 Copyleft：作为库被调用时通常不要求开源你自己的代码，但修改库本身需以 LGPL 开源；前端打包合并后的适用边界存在不同理解。以上为概括，不构成法律意见，请以许可原文为准。

### @canonical/storybook-addon-utils 的下载量有多少？

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

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

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