文档
Storybook 文档

故事渲染

在 Storybook 中,你的故事会在 Storybook Web 应用程序内部的一个特定的“预览” iframe(也称为画布)中渲染。预览的 JavaScript 构建配置由一个 构建器 配置控制,但你可能还希望为每个故事运行一些代码或直接控制渲染的 HTML,以帮助你的故事正确渲染。

为每个故事运行代码

在预览文件 (.storybook/preview.js|ts) 中执行的代码会为 Storybook 中的每个故事运行。这对于设置全局样式、初始化库或渲染组件所需的任何其他操作非常有用。

以下是如何使用预览文件初始化必须在组件渲染之前运行的库的示例

// .storybook/preview.ts
// Replace your-renderer with the renderer you are using (e.g., react, vue3)
import { Preview } from '@storybook/your-renderer';
 
import { initialize } from '../lib/your-library';
 
initialize();
 
const preview: Preview = {
  // ...
};
 
export default preview;

添加到 <head>

如果你需要在预览 iframe 的 head 中添加额外的元素,例如,加载静态样式表、字体文件或类似的内容,你可以创建一个名为 .storybook/preview-head.html 的文件,并添加以下标签

{/* .storybook/preview-head.html */}
 
{/* Pull in static files served from your Static directory or the internet */}
{/* Example: `main.js|ts` is configured with staticDirs: ['../public'] and your font is located in the `fonts` directory inside your `public` directory */}
<link rel="preload" href="/fonts/my-font.woff2" />
 
{/* Or you can load custom head-tag JavaScript: */}
 
<script src="https://use.typekit.net/xxxyyy.js"></script>
<script>
  try {
    Typekit.load();
  } catch (e) {}
</script>

Storybook 会将这些标签注入到你的组件渲染的预览 iframe 中,而不是 Storybook 应用程序 UI。

但是,也可以使用在 main.js 文件中定义的预设以编程方式修改预览 head HTML。有关详细信息,请阅读 预设文档

添加到 <body>

有时,你可能需要在 <body> 中添加不同的标签。有助于添加一些自定义内容根目录。

你可以通过在 .storybook 目录中创建一个名为 preview-body.html 的文件,并添加以下标签来实现这一点

{/*  .storybook/preview-body.html */}
 
<div id="custom-root"></div>

如果在项目中使用相对大小(如 remem),你可以通过将 style 标签添加到 preview-body.html 来更新基本 font-size

{/* .storybook/preview-body.html */}
 
<style>
  html {
    font-size: 15px;
  }
</style>

Storybook 会将这些标签注入到你的组件渲染的预览 iframe 中,而不是 Storybook 应用程序 UI。

就像你可以自定义预览 head HTML 标签一样,你也可以按照相同的步骤使用预设自定义预览 body。有关如何执行此操作的更多信息,请参阅 预设文档