storybook-addon-react-live-edit

安装

yarn add -D storybook-addon-react-live-edit

配置 Storybook

要在你的 Storybook 中使用此插件，你需要注册面板、addLiveSource Story 创建器，并可以选择添加一个作用域装饰器，以便在实时编辑器作用域中提供其他组件和实用程序

注册面板

添加到 .storybook/addons.js

import 'storybook-addon-react-live-edit/dist/register';

注册 addLiveSource Story 创建器

添加到 .storybook/config.js

import {setAddon} from '@storybook/react';
import LiveEdit, {setOptions} from 'storybook-addon-react-live-edit';

setOptions({ theme: 'darcula', presets: ['react'] });

setAddon(LiveEdit);

添加 withLiveEditScope Story 装饰器

将 addDecorator 添加到 .storybook/config.js

import {addDecorator} from '@storybook/react';
import {withLiveEditScope} from 'storybook-addon-react-live-edit';

import ExternalComponent from 'a-apackage';

addDecorator(withLiveEditScope({ ExternalComponent }));

或者

将 addDecorator 添加到特定的 Story

import {withLiveEditScope} from 'storybook-addon-react-live-edit';
import ExternalComponent from 'a-apackage';

storiesOf("Demo", module)
  .addDecorator(withLiveEditScope({ React, ExternalComponent }))
  .addLiveSource('demo', `return <div>{scopeTest}</div>`);

用法

当 LiveEdit 插件使用 Storybook 的 setAddon 函数注册时，可以使用新方法 addLiveSource 从作为字符串提供的源添加 Story。此源可以在“实时编辑”面板中进行编辑。

storiesOf("Demo", module)
  .addLiveSource('demo', `return <div>{scopeTest}</div>`);

或者

可以使用 withLiveEdit Story 创建器

storiesOf("Demo", module)
  .add('demo', withLiveEdit(`return <div>{scopeTest}</div>`));

API

addLiveSource

addLiveSource(name, source[, scope]) 

• name（字符串，必填） - Story 名称
• source（字符串，必填） - 要在预览中呈现并可在“实时编辑”面板中编辑的 Story 源代码
• scope（对象，可选） - 提供给呈现的 Story 的变量，这些变量可以是其他组件、实用程序或任何其他数据。作用域与 withLiveEditScope 装饰器先前提供的所有变量合并。

withLiveEdit

withLiveEdit(source[, scope]) 

• source（字符串，必填） - 要在预览中呈现并可在“实时编辑”面板中编辑的 Story 源代码
• scope（对象，可选） - 提供给呈现的 Story 的变量，这些变量可以是其他组件、实用程序或任何其他数据。作用域与 withLiveEditScope 装饰器先前提供的所有变量合并。

withLiveEditScope 装饰器

withLiveEditScope(scope)

• scope（对象，必填） - 提供给呈现的 Story 的变量，这些变量可以是其他组件、实用程序或任何其他数据。作用域与 withLiveEditScope 装饰器先前提供的所有变量合并。React 应该导入并在作用域对象中提供。

示例

要运行提供的示例，请执行以下命令，Storybook 将在端口 3000 上运行

yarn example