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.

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.

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

   • storybook: The Storybook core.
   • @storybook/addon-essentials: a curated collection of addons to bring out the best of Storybook.
   • @rsbuild/core: Storybook builder.
   • storybook-addon-rslib: This addon will make Storybook Rsbuild could derive Rsbuild configuration from Rslib config file. The addon will automatically read the Rslib configuration and apply it to Storybook Rsbuild, ensuring that the configuration is unified. You can check the storybook-addon-rslib documentation for available options.
   npm

   yarn

   pnpm

   bun

   npm add storybook @storybook/addon-essentials 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

   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-essentials', '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',
     },
   };

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#

• React component library + Rslib + Storybook