mirror of
https://github.com/storybookjs/storybook.git
synced 2025-04-06 07:21:16 +08:00
09bd49af77
On a page inside a new directory (e.g. `get-started/frameworks`), almost* every relative link that went up a level (e.g. `../writing-stories/args.mdx`) now needs to go up two levels (e.g. `../../writing-stories/args.mdx`). * The exception is relative links pointing to directories that are siblings of the current directory, e.g. on `configure/integration`, a link to `../user-interface/sidebar.mdx` does _not_ need adjusted.
113 lines
3.2 KiB
Plaintext
113 lines
3.2 KiB
Plaintext
---
|
||
title: Storybook for React & Vite
|
||
sidebar:
|
||
order: 3
|
||
title: React & Vite
|
||
---
|
||
|
||
Storybook for React & Vite is a [framework](../../contribute/framework.mdx) that makes it easy to develop and test UI components in isolation for [React](https://react.dev/) applications built with [Vite](https://vitejs.dev/). It includes:
|
||
|
||
* 🏎️ Pre-bundled for performance
|
||
* 🪄 Zero config
|
||
* 💫 and more!
|
||
|
||
<If notRenderer={'react'}>
|
||
<Callout variant="info">
|
||
Storybook for React & Vite is only supported in [React](?renderer=react) projects.
|
||
</Callout>
|
||
|
||
{/* End non-supported renderers */}
|
||
</If>
|
||
|
||
<If renderer={'react'}>
|
||
## Requirements
|
||
|
||
* React ≥ 16.8
|
||
* Vite ≥ 4.0
|
||
* Storybook ≥ 8.0
|
||
|
||
## Getting started
|
||
|
||
### In a project without Storybook
|
||
|
||
Follow the prompts after running this command in your React project's root directory:
|
||
|
||
{/* prettier-ignore-start */}
|
||
|
||
<CodeSnippets path="init-command.md" />
|
||
|
||
{/* prettier-ignore-end */}
|
||
|
||
[More on getting started with Storybook.](../install.mdx)
|
||
|
||
### In a project with Storybook
|
||
|
||
This framework is designed to work with Storybook 7+. If you’re not already using v7, upgrade with this command:
|
||
|
||
{/* prettier-ignore-start */}
|
||
|
||
<CodeSnippets path="storybook-upgrade.md" />
|
||
|
||
{/* prettier-ignore-end */}
|
||
|
||
#### Automatic migration
|
||
|
||
When running the `upgrade` command above, you should get a prompt asking you to migrate to `@storybook/react-vite`, which should handle everything for you. In case that auto-migration does not work for your project, refer to the manual migration below.
|
||
|
||
#### Manual migration
|
||
|
||
First, install the framework:
|
||
|
||
{/* prettier-ignore-start */}
|
||
|
||
<CodeSnippets path="react-vite-install.md" />
|
||
|
||
{/* prettier-ignore-end */}
|
||
|
||
Then, update your `.storybook/main.js|ts` to change the framework property:
|
||
|
||
{/* prettier-ignore-start */}
|
||
|
||
<CodeSnippets path="react-vite-add-framework.md" />
|
||
|
||
{/* prettier-ignore-end */}
|
||
|
||
## Run the Setup Wizard
|
||
|
||
If all goes well, you should see a setup wizard that will help you get started with Storybook introducing you to the main concepts and features, including how the UI is organized, how to write your first story, and how to test your components' response to various inputs utilizing [controls](../../essentials/controls.mdx).
|
||
|
||
|
||
|
||
If you skipped the wizard, you can always run it again by adding the `?path=/onboarding` query parameter to the URL of your Storybook instance, provided that the example stories are still available.
|
||
|
||
## API
|
||
|
||
### Options
|
||
|
||
You can pass an options object for additional configuration if needed:
|
||
|
||
```ts
|
||
// .storybook/main.ts
|
||
import type { StorybookConfig } from '@storybook/react-vite';
|
||
|
||
const config: StorybookConfig = {
|
||
framework: {
|
||
name: '@storybook/react-vite',
|
||
options: {
|
||
// ...
|
||
},
|
||
},
|
||
};
|
||
|
||
export default config;
|
||
```
|
||
|
||
#### `builder`
|
||
|
||
Type: `Record<string, any>`
|
||
|
||
Configure options for the [framework's builder](../../api/main-config/main-config-framework.mdx#optionsbuilder). For this framework, available options can be found in the [Vite builder docs](../../builders/vite.mdx).
|
||
|
||
{/* End supported renderers */}
|
||
</If>
|