Merge pull request #4800 from tobiasljungstrom/next

Update the Starter Guide for React
This commit is contained in:
Norbert de Langen 2018-11-17 19:44:24 +00:00 committed by GitHub
commit 1250d00fd8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -5,25 +5,25 @@ title: 'Storybook for React'
You may have tried to use our quick start guide to setup your project for Storybook. If you want to set up Storybook manually, this is the guide for you.
> This will also help you to understand how Storybook works.
This will also help you to understand how Storybook works.
## Starter Guide React
Storybook has its own Webpack setup and a dev server. Webpack setup is very similar to [Create React App](https://github.com/facebookincubator/create-react-app), but allows you to configure as you want.
Storybook has its own Webpack setup and a dev server. Webpack setup is very similar to [Create React App](https://github.com/facebookincubator/create-react-app), but allows you to configure it as you want.
In this guide, we will set up Storybook for your React project.
## Table of contents
- [Add @storybook/react](#add-storybookreact)
- [Add react, react-dom, and babel-core](#add-react-react-dom-and-babel-core)
- [Add react, react-dom, babel-core, and babel-loader](#add-react-react-dom-babel-core-and-babel-loader)
- [Create the config file](#create-the-config-file)
- [Write your stories](#write-your-stories)
- [Run your Storybook](#run-your-storybook)
## Add @storybook/react
First of all, you need to add `@storybook/react` to your project. To do that, simply run:
First of all, you need to add `@storybook/react` to your project. To do that, run:
```sh
npm i --save-dev @storybook/react
@ -31,7 +31,7 @@ npm i --save-dev @storybook/react
## Add react, react-dom, babel-core, and babel-loader
Make sure that you have `react`, `react-dom`, `@babel/core`, and `babel-loader` in your dependencies as well because we list these as a peerDependency:
Make sure that you have `react`, `react-dom`, `babel-core`, and `babel-loader` in your dependencies as well because we list these as a peer dependencies:
```sh
npm i --save react react-dom
@ -39,7 +39,7 @@ npm i --save-dev @babel/core
npm i --save-dev babel-loader
```
Then add the following NPM script to your package json in order to start the storybook later in this guide:
Then add the following NPM script to your `package.json` in order to start the storybook later in this guide:
```json
{
@ -54,9 +54,9 @@ Then add the following NPM script to your package json in order to start the sto
Storybook can be configured in several different ways.
Thats why we need a config directory. We've added a `-c` option to the above NPM script mentioning `.storybook` as the config directory.
For the basic Storybook configuration file, you don't need to do much, but simply tell Storybook where to find stories.
For a basic Storybook configuration, the only thing you need to do is tell Storybook where to find stories.
To do that, simply create a file at `.storybook/config.js` with the following content:
To do that, create a file at `.storybook/config.js` with the following content:
```js
import { configure } from '@storybook/react';
@ -80,26 +80,25 @@ Now you can write some stories inside the `../stories/index.js` file, like this:
```js
import React from 'react';
import { storiesOf } from '@storybook/react';
import { action } from '@storybook/addon-actions';
import { Button } from '@storybook/react/demo';
storiesOf('Button', module)
.add('with text', () => (
<Button onClick={action('clicked')}>Hello Button</Button>
<Button>Hello Button</Button>
))
.add('with some emoji', () => (
<Button onClick={action('clicked')}><span role="img" aria-label="so cool">😀 😎 👍 💯</span></Button>
<Button><span role="img" aria-label="so cool">😀 😎 👍 💯</span></Button>
));
```
Story is a single state of your component. In the above case, there are two stories for the native button component:
Each story is a single state of your component. In the above case, there are two stories for the demo button component:
1. with text
2. with some emoji
1. With text
2. With some emoji
## Run your Storybook
Now everything is ready. Simply run your storybook with:
Now everything is ready. Run your storybook with:
```sh
npm run storybook
@ -109,4 +108,4 @@ Then you can see all your stories, like this:
![Basic stories](../static/basic-stories.png)
Now you can change components and write stories whenever you need to. You'll get those changes into Storybook in a snap with the help of Webpack's HMR API.
Now you can change components and write stories whenever you need to. You'll see the changes in Storybook immediately since it uses Webpack's hot module reloading.