@canonical/storybook-addon-utils

中文文档
0.45.0发布于 2026/10/23LGPL-3.0TypeScriptES Module构建来源已验证近 30 天下载 9542

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

中文使用文档
文档目录6 节
  1. 安装
  2. 设置
  3. 工具栏控件
  4. 故事参数
  5. CSS 自定义属性
  6. 所需资源

@ canonical/ 故事本- addon- utils

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

安装

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

设置

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

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

export default config;

工具栏控件

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

故事参数

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

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-colorrgba(255, 0, 0, 0.2)基线网格线颜色
--baseline-height0.5rem基线网格间隔
--debug-outline-colorlight-dark(rgba(0,128,80,0.25), rgba(80,220,140,0.25))元素大纲颜色

所需资源

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

版本与发布记录

@canonical/storybook-addon-utils 共发布 27 个版本,首次发布于 2026/04/01;过去 12 个月发布了 27 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.45.0latest2026/10/2317 天前
0.44.12026/10/081 个月前
0.44.02026/10/051 个月前
0.43.02026/10/011 个月前
0.42.02026/09/281 个月前
0.40.02026/09/211 个月前

关于 @canonical/storybook-addon-utils 的常见问题

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