文档插件
Storybook Docs

插件简介

插件通过非核心内置的功能和集成来扩展 Storybook。大多数 Storybook 功能都是作为插件实现的。例如:文档可访问性测试交互式控件等。插件 API 可让您轻松地以新方式配置和自定义 Storybook。社区制作了无数插件,可以解锁节省时间的流程。

浏览我们的插件目录来安装现有插件或作为您自己插件的灵感。

Storybook 基础知识

在编写你的第一个插件之前,让我们先了解一下 Storybook 架构的基础知识。虽然 Storybook 提供了一个统一的用户界面,但在幕后,它被分为“管理器”和“预览”。

管理器是负责渲染的 UI

  • 🔍 搜索
  • 🧭 导航
  • 🔗 工具栏
  • 📦 插件

预览区域是一个 iframe,你的故事在此渲染。

Storybook detailed window

由于这两个元素都在各自独立的 iframes 中运行,它们使用通信通道来保持同步。例如,当你在管理器中选择一个故事时,会通过通道分发一个事件,通知预览渲染该故事。

插件的结构

Storybook 插件可让您扩展 Storybook 现有的功能,涵盖从用户界面API的各个方面。每个插件都分为两大类。

基于 UI 的插件

基于 UI 的插件专注于自定义 Storybook 用户界面以扩展您的开发工作流程。基于 UI 的插件示例包括:控件文档可访问性

了解如何编写插件 »

预设插件

预设插件可帮助您将 Storybook 与其他技术和库集成。预设插件的示例是preset-create-react-app

了解如何编写预设插件 »