close
Rslib
  • English

      • Use Storybook

      Storybook is a powerful tool for developing UI components in isolation for React, Vue, and other frameworks. It enables you to build and test components independently, which can accelerate both development and testing.

      storybook-rsbuild is the Rsbuild powered Storybook builder, and provided the framework integration for React, Vue3 and vanilla JavaScript. The coherent Rsbuild system could make Storybook use an unified configuration with Rslib.

      Storybook Rsbuild version map

      The table below shows how Storybook Rsbuild matches Storybook versions. If you are on Storybook v9 or earlier, follow the official migration guide to upgrade to the latest release.

      StorybookStorybook Rsbuild
      v10^3.0.0
      v9^2.0.0
      v8^1.0.0

      Getting started

      Setup a Rslib project

      This is the prerequisite for setting up Storybook. You need to have a Rslib project with components that you want to showcase in Storybook, check out Solution to setup a Rslib project.

      Tip

      You can create a new project with Storybook already wired up via create-rslib, without manual setup.

      Add Storybook to project

      Set up a Storybook project with an existing Rslib project. To use React, Vue 3, vanilla JavaScript, or other frameworks, you must first install the appropriate Storybook framework package. For installation instructions, refer to the Storybook Rsbuild documentation.

      Using React as an example, at this step you need to:

      1. Install the dependencies for Storybook Rsbuild React framework. The essential ones include

        npm
        yarn
        pnpm
        bun
        npm add storybook @storybook/react @storybook/addon-docs @storybook/addon-onboarding storybook-addon-rslib @rsbuild/core -D

        The dependencies varies for each framework, please refer to the Storybook Rsbuild documentation for details. In this React example, we will install storybook-react-rsbuild as the framework integration.

        React
        Vue
        npm
        yarn
        pnpm
        bun
        deno
        npm add storybook-react-rsbuild -D

      2. Configure the Storybook configuration file .storybook/main.js, specify the stories and addons, and set the framework with corresponding framework integration.

        .storybook/main.js
        export default {
  stories: [
    '../stories/**/*.mdx',
    '../stories/**/*.stories.@(js|jsx|mjs|ts|tsx)',
  ],
  addons: [
    '@storybook/addon-docs',
    '@storybook/addon-onboarding',
    'storybook-addon-rslib',
  ],
  framework: 'storybook-react-rsbuild', // storybook-react-rsbuild for example
};

      3. Add a simple story to the stories directory. For example, create a Button.stories.js file with the following content:

        stories/Button.stories.js
        import { Button } from '../src/Button';

const meta = {
  title: 'Example/Button',
  component: Button,
};

export default meta;

export const Primary = {
  args: {
    primary: true,
    label: 'Button',
  },
};
      Tip

      In case you are using Yarn Plug-n-Play or your project is set up within a mono repository environment, you might run into issues with module resolution. In such cases, you can add an getAbsolutePath('storybook-addon-rslib') function to resolve the addon. Check the Storybook's FAQ for more information.

      There you go, you could start and build the Storybook server with the following command:

      npx storybook dev   // development mode
npx storybook build // build static files

      Check out more details in the Storybook Rsbuild documentation and the Storybook documentation.

      Example