mirror of
https://github.com/storybookjs/storybook.git
synced 2025-04-02 05:03:44 +08:00
48 lines
2.1 KiB
Markdown
48 lines
2.1 KiB
Markdown
# Storybook for React
|
|
|
|
Storybook for React is a UI development environment for your React components.
|
|
With it, you can visualize different states of your UI components and develop them interactively.
|
|
|
|
|
|
|
|
Storybook runs outside of your app.
|
|
So you can develop UI components in isolation without worrying about app specific dependencies and requirements.
|
|
|
|
## Getting Started
|
|
|
|
```sh
|
|
cd my-react-app
|
|
npx storybook init
|
|
```
|
|
|
|
For more information visit: [storybook.js.org](https://storybook.js.org)
|
|
|
|
---
|
|
|
|
Storybook also comes with a lot of [addons](https://storybook.js.org/addons) and a great API to customize as you wish.
|
|
You can also build a [static version](https://storybook.js.org/docs/react/sharing/publish-storybook) of your Storybook and deploy it anywhere you want.
|
|
|
|
Here are some featured storybooks that you can reference to see how Storybook works:
|
|
|
|
- [Demo of Storybook Design System](https://storybook.js.org/design-system) - [source](https://github.com/storybookjs/design-system)
|
|
|
|
## Create React App
|
|
|
|
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 Create React App features, including Sass/SCSS and TypeScript.
|
|
|
|
If you're working on an app that was initialized manually (i.e., without the use of Create React App), 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.
|
|
|
|
## Typescript
|
|
|
|
`@storybook/react` is now exporting its own types to use with Typescript.
|
|
You don't need to have `@types/storybook__react` installed anymore if it was your case.
|
|
But you probably also need to use types from `@types/node @types/react`.
|
|
|
|
## Docs
|
|
|
|
- [Basics](https://storybook.js.org/docs/react/get-started/introduction)
|
|
- [Configurations](https://storybook.js.org/docs/react/configure/overview)
|
|
- [Addons](https://storybook.js.org/docs/react/configure/storybook-addons)
|