@storybook/react-vite

What is @storybook/react-vite?

@storybook/react-vite is a package that integrates Storybook with Vite for React projects. It allows developers to build and test UI components in isolation with the fast and modern build tool Vite.

What are @storybook/react-vite's main functionalities?

Setup Storybook with Vite

This command initializes a new Storybook configuration in your React project using Vite as the builder. It sets up the necessary files and dependencies to get started with Storybook and Vite.

npx sb init --builder @storybook/react-vite

Writing Stories

This code demonstrates how to write a story for a Button component in a React project. It defines a default export with metadata about the component and creates a template for the story. The `Primary` story is an instance of the template with specific arguments.

import React from 'react';
import { Button } from './Button';

export default {
  title: 'Example/Button',
  component: Button,
};

const Template = (args) => <Button {...args} />;

export const Primary = Template.bind({});
Primary.args = {
  primary: true,
  label: 'Button',
};

Running Storybook

This command starts the Storybook development server, allowing you to view and interact with your stories in the browser. It uses Vite for fast builds and hot module replacement.

npm run storybook

Other packages similar to @storybook/react-vite

@storybook/react

@storybook/react is the standard Storybook package for React projects. It uses Webpack as the default builder, which may be slower compared to Vite but is more mature and has broader plugin support.

storybook-builder-vite

storybook-builder-vite is another package that integrates Vite with Storybook. It is an alternative to @storybook/react-vite and offers similar performance benefits by leveraging Vite's fast build times.

README

Storybook for React & Vite

See documentation for installation instructions, usage examples, APIs, and more.

Changelog

8.0.4

• Addon Docs: Support Stencil based display names in source snippets - #26592, thanks @yannbf!
• CLI: Instruct the correct auto-migration command - #26515, thanks @ndelangen!
• CLI: Throw an error when running upgrade command in incorrect cwd - #26585, thanks @yannbf!