Getting Started
The repository contains the Storybook (v8) Rsbuild builder and UI framework integrations.
For users of Storybook v9, Storybook Rsbuild already provides basic alpha version support. Check out the v2 branch (using version 2.0-alpha.x), and refer to the Storybook v9 migration documentation.
| package | description |
|---|---|
| storybook-builder-rsbuild | Rsbuild powered builder for Storybook |
| storybook-react-rsbuild | React integration for Storybook with Rsbuild builder |
| storybook-vue3-rsbuild | Vue 3 integration for Storybook with Rsbuild builder |
| storybook-html-rsbuild | Vanilla JS/TS integration for Storybook with Rsbuild builder |
| storybook-html-web-components | Web components (Lit) integration for Storybook with Rsbuild builder |
| storybook-addon-rslib | Addon to load config from Rslib |
Usage
@rsbuild/core >= 1.0.1: The builder relies on Rsbuild's 1.0 stable version. Check out Rsbuild's 1.0 announcement for more details.storybook >= 8.2.1: Storybook made some internal refactor in major version, 8.2.1 is tested out. (check out Storybook's release note for migrating from v7)
In Storybook v8, you don't need to manually install storybook-builder-rsbuild, it has been depended by the framework, such as storybook-react-rsbuild and storybook-vue3-rsbuild.
Refer to the documentation below for integration with the supported frameworks.
Use with frameworks
React
Vue
See integrating with Vue.
Vanilla JS/TS
See integrating with vanilla JavaScript / TypeScript.
Web components
See integrating with web components (Lit).
Integration
With Rslib
Integrating with Rslib to load the configuration seamlessly.
With Rspack
Integrating with project that uses Rspack.