Story rendering

在 Storybook 中，您的 stories 在一个特定的“预览” iframe（也称为 Canvas）中渲染，该 iframe 位于更大的 Storybook Web 应用程序内部。预览的 JavaScript 构建配置由构建器配置控制，但您可能还希望为每个 story 运行一些代码或直接控制渲染的 HTML，以帮助您的 stories 正确渲染。

为每个 story 运行代码

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

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

.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>

如果在您的项目中使用相对尺寸（例如 rem 或 em），您可以通过向 preview-body.html 添加 style 标签来更新基本 font-size

.storybook/preview-body.html

<style>
  html {
    font-size: 15px;
  }
</style>

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

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