storybook-addon-playground

Storybook Addon Playground

Develop locally

Install dependencies and start

npm i
npm start

Go to localhost:6006

How to add to your Storybook project

Install

npm install -D storybook-addon-playground

Register addon

On your .storybook/main.ts file, add the following:

const config = {
  addons: [
    // rest of your addons ...
    "storybook-addon-playground",
  ],
};

Addon Configuration

The addon configuration is done through Storybook's preview. Few of the parameters are required for the addon to work properly:

• storyId: Required. The story id that your playground has on Storybook.
• components: Required. An object with the components that should be rendered in the playground. The key is the component name and the value is the component itself.
• autocompletions: Optional. An array of autocompletions that should be used on the playground. Default is an empty array. We recommend on using react-docgen to generate a documentation output and run our util function on the output. You can use whatever tool you'd like as long as it matches the expected format in the addon. Default is no autocompletions.
• editorTheme: Optional. The theme that should be used on the playground. Default is your Storybook theme.
• initialCode: Optional. The initial code ("welcome") that should be rendered on the playground. Default is empty editor.

On your .storybook/preview.ts file, you should add something similar to the following:

import MyComponentsLibrary from "my-components-library";
import MyIconsLibrary from "my-icons-library";
import reactDocgenOutput from "./react-docgen-output.json";
import { generateAutocompletions } from "storybook-addon-playground";

const preview = {
  parameters: {
    playground: {
      storyId: "playground",
      components: { ...MyComponentsLibrary, ...MyIconsLibrary },
      autocompletions: generateAutocompletions(reactDocgenOutput),
      editorTheme: "light",
      introCode: { jsx: `<div>Welcome to my Playground!</div>`, css: "" },
    },
  },
};

Render a story including the playground in the sidebar

Create a story with the following content:

import { withPlayground } from "storybook-addon-playground";

export default {
  title: "Playground",
  decorators: [withPlayground],
};

export const Playground = {};

Build

Vite

Vite is used to build the local Storybook for testing and dev purposes

Rollup

Rollup is used to build the addon for publishing

graph TD;
    subgraph ADDON
    A{{Rollup}}
    B[index.ts]
    C[manager.ts]

    D[Panel addon]
    E[Tool addon]

    F[withPlayground]
    U[generateAutocompletions]
    G[PlaygroundPreview]
    H[react-live]

    I[Editor]
    J[useCopyToClipboard]
    K[usePlaygroundArgs]
    Q[useInitialCode]
    R[useBroadcastEditorChanges]
    S[usePlaygroundState]
    T[useEditorTheme]
    L[useToolbarActions]
    M[prettier]
    N[react-codemirror]

    O[Toolbar icon]

    P[Storybook Addon API]

    A -->|Entry| B
    A -->|Entry| C

    B -->|Exports| F
    B -->|Exports| U

    P --> D
    P --> E

    E -->|Renders| O

    C -->|Registers Addons| P

    F -->|Renders in a story| G
    G ======>|Using lib| H

    D -->|Calls| Q
    D -->|Calls| R
    R -->|Uses| S
    D --->|Renders| I
    I ====>|Using lib| N
    I -->|Uses| L
    I -->|Uses| K
    I -->|Uses| T

    L ===>|Using lib| M
    L -->|Uses| J
    end

    subgraph UI
    X{{Vite}}
    Z["Storybook UI (.storybook - Testing and Development)"]
    X --> Z
    end

Changelog

1.4.0 (2024-03-18)

Features

• add autocomplete abilities for the playground editor (#43) (9c0f2d7)