mirror of
https://github.com/storybookjs/storybook.git
synced 2025-04-04 10:51:05 +08:00
223 lines
8.8 KiB
Plaintext
223 lines
8.8 KiB
Plaintext
---
|
||
title: Storybook for React Native Web
|
||
sidebar:
|
||
order: 6
|
||
title: React Native Web
|
||
---
|
||
|
||
Storybook for React Native Web is a [framework](../../contribute/framework.mdx) that makes it easy to develop and test UI components in isolation for [React Native](https://reactnative.dev/) applications. It uses [Vite](https://vitejs.dev/) to build your components for web browsers. The framework includes:
|
||
|
||
* ⚛️ React Native components
|
||
* 🧑💻 Shareable on the web
|
||
* 🪄 Zero config
|
||
* 💫 and more!
|
||
|
||
<If notRenderer="react-native-web">
|
||
<Callout variant="info">
|
||
Storybook for React Native Web is only supported in [React Native](?renderer=react-native-web) projects.
|
||
</Callout>
|
||
|
||
{/* End non-supported renderers */}
|
||
</If>
|
||
|
||
<If renderer="react-native-web">
|
||
<Callout variant="info">
|
||
In addition to React Native Web, Storybook supports on-device [React Native](https://github.com/storybookjs/react-native) development. If you're unsure what's right for you, read our [comparison](#react-native-vs-react-native-web).
|
||
</Callout>
|
||
|
||
## Requirements
|
||
|
||
* React-Native ≥ 0.72
|
||
* React-Native-Web ≥ 0.19
|
||
* Storybook ≥ 8.5
|
||
* Vite ≥ 5.0
|
||
|
||
## Getting started
|
||
|
||
### In a project without Storybook
|
||
|
||
Follow the prompts after running this command in your React Native project's root directory:
|
||
|
||
{/* prettier-ignore-start */}
|
||
|
||
<CodeSnippets path="create-command.md" />
|
||
|
||
{/* prettier-ignore-end */}
|
||
|
||
[More on getting started with Storybook.](../install.mdx)
|
||
|
||
### In a project with Storybook `addon-react-native-web`
|
||
|
||
The [React Native Web addon](https://github.com/storybookjs/addon-react-native-web) was a Webpack-based precursor to the React Native Web Vite framework (i.e., `@storybook/react-native-web-vite`). If you're using the addon, you should migrate to the framework, which is faster, more stable, maintained, and better documented. To do so, follow the steps below.
|
||
|
||
Run the following command to upgrade Storybook to the latest version:
|
||
|
||
{/* prettier-ignore-start */}
|
||
|
||
<CodeSnippets path="storybook-upgrade.md" />
|
||
|
||
{/* prettier-ignore-end */}
|
||
|
||
<Callout variant="info">
|
||
This framework is designed to work with Storybook 8.5 and above for the best experience. We won't be able to provide support if you're using an older Storybook version.
|
||
</Callout>
|
||
|
||
Install the framework and its peer dependencies:
|
||
|
||
{/* prettier-ignore-start */}
|
||
|
||
<CodeSnippets path="react-native-web-vite-install.md" />
|
||
|
||
{/* prettier-ignore-end */}
|
||
|
||
Update your `.storybook/main.js|ts` to change the framework property and remove the `@storybook/addon-react-native-web` addon:
|
||
|
||
{/* prettier-ignore-start */}
|
||
|
||
<CodeSnippets path="react-native-web-vite-add-framework.md" />
|
||
|
||
{/* prettier-ignore-end */}
|
||
|
||
Finally, remove the addon and similar packages (i.e., `@storybook/react-webpack5` and `@storybook/addon-react-native-web`) from your project.
|
||
|
||
### In a project with Storybook `react-native`
|
||
|
||
[Storybook for React Native](https://github.com/storybookjs/react-native) is a framework that runs in a simulator or on your mobile device. It's possible to run React Native Web alongside React Native, but we are still working on a seamless integration. In the meantime, we recommend running one or the other. If you need help figuring out what's right for you, read our [comparison](#react-native-vs-react-native-web).
|
||
|
||
## Run the Setup Wizard
|
||
|
||
If all goes well, you should see a setup wizard that will help you get started with Storybook. The wizard will introduce 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.
|
||
|
||
## React Native vs React Native Web
|
||
|
||
If you’re building React Native (RN) components, Storybook has two options: Native and Web.
|
||
|
||
Both options provide a catalog of your stories that hot refreshes as you edit the code in your favorite editor. However, their implementations are quite different:
|
||
|
||
- **Native** - Runs inside your React Native application. It’s high-fidelity but has a limited feature set.
|
||
- **Web** - Displays your React Native components in the browser. It’s based on Storybook for Web, which is feature-rich and mature.
|
||
|
||
{/* TODO: Don't forget about this image, otherwise remove it */}
|
||
|
||
{/* [Image: native + web] */}
|
||
|
||
So, which option is right for you?
|
||
|
||
**Native.** You should choose this option if you want:
|
||
|
||
- **Native features** - Your components rely on device-specific features like native modules. It runs in your actual application, in-simulator, or on-device and provides full fidelity. The web version uses `react-native-web`, which works for most components but has [limitations](https://necolas.github.io/react-native-web/docs/react-native-compatibility/).
|
||
- **Mobile publication** - You want to share your Storybook on-device as part of a test build or embedded inside your application.
|
||
|
||
**Web.** You should choose this option if you want:
|
||
|
||
- [**Sharing**](../../sharing/publish-storybook.mdx) - Publish to the web and share with your team or publicly.
|
||
- [**Documentation**](../../writing-docs/index.mdx) - Auto-generated component docs or rich markdown docs in MDX.
|
||
- [**Testing**](../../writing-tests/index.mdx) - Component, visual, and a11y tests for your components.
|
||
- [**Addons**](https://storybook.js.org/addons) - 500+ addons that improve development, documentation, testing, and integration with other tools.
|
||
|
||
**Both.** It’s also possible to use both options together. However, this increases Storybook’s install footprint and requires more work to configure. Therefore, we recommend choosing one option to start and extending it once you have something working.
|
||
|
||
## API
|
||
|
||
### Options
|
||
|
||
You can pass an options object for additional configuration if needed:
|
||
|
||
```ts title=".storybook/main.ts"
|
||
import type { StorybookConfig } from '@storybook/react-native-web-vite';
|
||
|
||
const config: StorybookConfig = {
|
||
framework: {
|
||
name: '@storybook/react-native-web-vite',
|
||
options: {
|
||
// You should apply babel plugins and presets here for your project that you want to apply to your code
|
||
// for example put the reanimated preset here if you are using reanimated
|
||
// or the nativewind jsxImportSource for example
|
||
pluginReactOptions: {
|
||
jsxRuntime: 'automatic' | 'classic', // default: 'automatic'
|
||
jsxImportSource: string, // default: 'react'
|
||
babel:{
|
||
plugins: Array<string | [string, any]>,
|
||
presets: Array<string | [string, any]>,
|
||
// ... other compatible babel options
|
||
}
|
||
include: Array<string|RegExp>,
|
||
exclude: Array<string|RegExp>,
|
||
// ... other compatible @vitejs/plugin-react options
|
||
}
|
||
|
||
// these options are used to configure transpilation of node_modules via babel
|
||
// in most cases, you don't need to configure these options, but they are available if you need them
|
||
pluginBabelOptions: {
|
||
include: Array<string|RegExp>, // default: [/node_modules\/(react-native|@react-native)/]
|
||
exclude: Array<string|RegExp>, // default: undefined
|
||
presets: Array<string|[string, any]>,
|
||
plugins: Array<string|[string, any]>,
|
||
presetReact?: {
|
||
runtime?: 'automatic' | 'classic'; // default: 'automatic'
|
||
importSource?: string; // default: 'react'
|
||
};
|
||
// ... other compatible vite-plugin-babel options
|
||
}
|
||
},
|
||
},
|
||
};
|
||
|
||
export default config;
|
||
```
|
||
#### Example configuration for reanimated
|
||
|
||
```ts title=".storybook/main.ts"
|
||
const main: StorybookConfig = {
|
||
// ... rest of config
|
||
|
||
framework: {
|
||
name: "@storybook/react-native-web-vite",
|
||
options: {
|
||
pluginReactOptions: {
|
||
babel: {
|
||
plugins: [
|
||
"@babel/plugin-proposal-export-namespace-from",
|
||
"react-native-reanimated/plugin",
|
||
],
|
||
},
|
||
},
|
||
},
|
||
},
|
||
|
||
// ... rest of config
|
||
}
|
||
```
|
||
|
||
#### Example configuration for nativewind
|
||
|
||
```ts title=".storybook/main.ts"
|
||
|
||
const main: StorybookConfig = {
|
||
// ... rest of config
|
||
|
||
framework: {
|
||
name: "@storybook/react-native-web-vite",
|
||
options: {
|
||
pluginReactOptions: {
|
||
jsxImportSource: "nativewind",
|
||
},
|
||
},
|
||
},
|
||
}
|
||
```
|
||
|
||
#### `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>
|