mirror of
https://github.com/storybookjs/storybook.git
synced 2025-04-07 03:31:06 +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.
139 lines
4.4 KiB
Plaintext
139 lines
4.4 KiB
Plaintext
---
|
||
title: Storybook for React & Webpack
|
||
sidebar:
|
||
order: 4
|
||
title: React & Webpack
|
||
---
|
||
|
||
Storybook for React & Webpack 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 [Webpack](https://webpack.js.org/).
|
||
|
||
<If notRenderer={'react'}>
|
||
<Callout variant="info">
|
||
Storybook for React & Webpack is only supported in [React](?renderer=react) projects.
|
||
</Callout>
|
||
|
||
{/* End non-supported renderers */}
|
||
</If>
|
||
|
||
<If renderer={'react'}>
|
||
## Requirements
|
||
|
||
* React ≥ 16.8
|
||
* Webpack ≥ 5.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-webpack5`, 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-webpack5-install.md" />
|
||
|
||
{/* prettier-ignore-end */}
|
||
|
||
Next, install and register your appropriate compiler addon, depending on whether you're using SWC (recommended) or Babel:
|
||
|
||
<Callout variant="info">
|
||
If your project is using [Create React App](#create-react-app-cra), you can skip this step.
|
||
</Callout>
|
||
|
||
{/* prettier-ignore-start */}
|
||
|
||
<CodeSnippets path="storybook-addon-compiler-swc-auto-install.md" />
|
||
|
||
{/* prettier-ignore-end */}
|
||
|
||
or
|
||
|
||
{/* prettier-ignore-start */}
|
||
|
||
<CodeSnippets path="storybook-addon-compiler-babel-auto-install.md" />
|
||
|
||
{/* prettier-ignore-end */}
|
||
|
||
More details can be found in the [Webpack builder docs](../../builders/webpack.mdx#compiler-support).
|
||
|
||
Finally, update your `.storybook/main.js|ts` to change the framework property:
|
||
|
||
{/* prettier-ignore-start */}
|
||
|
||
<CodeSnippets path="react-webpack5-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.
|
||
|
||
## Create React App (CRA)
|
||
|
||
Support for [Create React App](https://create-react-app.dev/) is handled by [`@storybook/preset-create-react-app`](https://github.com/storybookjs/presets/tree/master/packages/preset-create-react-app).
|
||
|
||
This preset enables support for all CRA features, including Sass/SCSS and TypeScript.
|
||
|
||
If you're working on an app that was initialized manually (i.e., without the use of CRA), ensure that your app has [react-dom](https://www.npmjs.com/package/react-dom) included as a dependency. Failing to do so can lead to unforeseen issues with Storybook and your project.
|
||
|
||
## API
|
||
|
||
### Options
|
||
|
||
You can pass an options object for additional configuration if needed:
|
||
|
||
```ts
|
||
// .storybook/main.ts
|
||
import type { StorybookConfig } from '@storybook/react-webpack5';
|
||
|
||
const config: StorybookConfig = {
|
||
framework: {
|
||
name: '@storybook/react-webpack5',
|
||
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 [Webpack builder docs](../../builders/webpack.mdx).
|
||
|
||
{/* End supported renderers */}
|
||
</If>
|