Skip to content

Latest commit

 

History

History
47 lines (29 loc) · 2.16 KB

README.md

File metadata and controls

47 lines (29 loc) · 2.16 KB

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 Screenshot

Storybook runs outside of your app. So you can develop UI components in isolation without worrying about app specific dependencies and requirements.

Getting Started

cd my-react-app
npx sb init

For more information visit: storybook.js.org


Storybook also comes with a lot of addons and a great API to customize as you wish. You can also build a static version of your storybook and deploy it anywhere you want.

Here are some featured storybooks that you can reference to see how Storybook works:

Create React App

Support for Create React App is handled by @storybook/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 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