Storybook live examples plugin
Storybook live examples plugin
npm install storybook-addon-live-examples
594
Downloads per week

โšก Storybook Addon Live Examples โšก

Code playground with live editing inside your storybook

  • ๐Ÿง‘โ€๐Ÿ’ป Play with code without 3rd-party service services like codepen
  • ๐Ÿ‘ฅ Share examples with others
  • ๐Ÿ› Share links to bug reproductions with others
  • ๐Ÿงฑ Check how the components work together
  • Typescript supported

Read docs or Try live demo

Getting started

1. Install addon

yarn add -D storybook-addon-live-examples
# npm install --save-dev storybook-addon-live-examples

2. Register addon in main.js

module.exports = {
    addons: ['storybook-addon-live-examples'],
};

3. Setup addon in preview.js (optional step)

import { addons } from '@storybook/addons';
import { LIVE_EXAMPLES_ADDON_ID } from 'storybook-addon-live-examples';
import theme from 'prism-react-renderer/themes/github';

import AllComponents from '../packages';

addons.setConfig({
    [LIVE_EXAMPLES_ADDON_ID]: {
        // custom theme from prism-react-renderer (optional)
        editorTheme: theme,
        // internationalization (optional)
        copyText: ['Copy', 'Copied'],
        expandText: ['Show code', 'Hide code'],
        shareText: ['Share', 'Shared'],
        // scope (globally accessible components & functions) (optional)
        scope: {
            ...AllComponents,
            someFunction: () => 42
        },
    },
});

Usage

CSF

Live examples will be rendered instead of the default addon-docs canvas.

Your can customize examples by parameters:

export default {
    title: 'Components/Button',
    parameters: {
        scope: {
            scopeValue,
        },
    }
};

const scopeValue = 42;

export const Primary = () => <button>{scopeValue}</button>;

Primary.parameters = {
    expanded: true
};

export const Secondary = () => <button>{scopeValue}</button>;

NOTE: Most likely you will get errors after addon installing. Don't panic, just pass all variables that are used in your story to scope

MDX

Inside MDX-based stories you can write your code examples with plain markdown.

Just put your code inside triple quotes

|```tsx live
|<h4>Wow, so simple</h4>
|```

Or render custom Canvas

// Import custom Canvas from addon
import { Canvas } from 'storybook-addon-live-examples';

<Canvas live={true} scope={{ value: 42 }}>
    <h4>Wow, so simple, {value}</h4>
</Canvas>

Or use Example directly

import { Example } from 'storybook-addon-live-examples';

<Example live={true} code={`<h4>Wow, so simple</h4>`} />

CSF With MDX

// Button.stories.js

import mdx from './Button.mdx';

export default {
    title: 'Components/Button',
    parameters: {
        docs: {
            page: mdx,
        },
    },
};

const scopeValue = 42;

export const Primary = () => <button>{scopeValue}</button>;

Primary.parameters = {
    scope: {
        scopeValue,
    },
};
// Button.mdx

import { ArgsTable, Story } from '@storybook/addon-docs';

import { Button } from './Button';

# Button

<ArgsTable of={Button} />

<Story id='components-button--primary' />

Example props

You can customize the display of examples with props or metastring

live

|```tsx live
|<span>This example can be edited</span>
|```
<span>This example can be edited</span>

expanded

|```tsx live expanded
|<span>This example will be rendered with expanded code sources</span>
|```
<span>This example will be rendered with expanded code sources</span>

Complex examples

render(() => {
    const [counter, setCounter] = React.useState(0);
    return (
        <>
            <h2>Super live counter: {counter}</h2>
            <button type='button' onClick={() => setCounter((c) => c + 1)}>
                Increment
            </button>
        </>
    );
});

Scope

Storybook-addon-live-examples uses react-live under the hood.

Scope allows you to pass some globals to your code examples. By default it injects React only, which means that you can use it in code like this:

render(() => {
//                                โ†“โ†“โ†“โ†“โ†“
    const [counter, setCounter] = React.useState(0);
    return counter;
}

- Pass your own components to scope by props

import { Canvas } from 'storybook-addon-live-examples';
import MyComponent from '../packages/my-component';

<Canvas live={true} scope={{ MyComponent }}>
    <MyComponent>Amazing</MyComponent>
</Canvas>

- Setup scope globally

This is the easiest way to setup scope once for an entire project

//.storybook/manager.js

import { addons } from '@storybook/addons';
import { LIVE_EXAMPLES_ADDON_ID } from 'storybook-addon-live-examples';

addons.setConfig({
    [LIVE_EXAMPLES_ADDON_ID]: {
        scope: {
            MyComponent,
        },
    },
});
<MyComponent>Now, you can use MyComponent in all examples</MyComponent>

- Setup scope inside monorepo

This is an example of how you can add all used components and helpers to the scope.

// .storybook/scope.ts

import { ComponentType } from 'react';

import * as icons from 'some-icons-pack';
import * as knobs from '@storybook/addon-knobs';

// packages/{componentName}/index.ts
const req = require.context('../packages', true, /^\.\/(.*)\/index.ts$/);

const components = req.keys().reduce((acc: Record<string, ComponentType>, key) => {
    Object.entries(req(key)).forEach(([componentName, component]: [string, any]) => {
        acc[componentName] = component;
    });

    return acc;
}, {});

export default {
    ...components,
    ...icons,
    ...knobs,
};

// .storybook/manager.js

import scope from './scope';

addons.setConfig({
    [LIVE_EXAMPLES_ADDON_ID]: {
        scope,
    },
});