storybook

What is storybook?

Storybook is an open-source tool for developing UI components in isolation for React, Vue, Angular, and more. It makes building stunning UIs organized and efficient. Storybook provides a sandbox to build UI components in isolation so you can develop hard-to-reach states and edge cases.

What are storybook's main functionalities?

UI Component Exploration

Developers can browse through the components and their different states to understand how components look and feel in isolation.

n/a

UI Component Documentation

Storybook allows developers to create documentation for each component, which can include usage instructions, design notes, and other important information.

n/a

Visual Testing

With Storybook, you can write stories to capture the states of your UI components. These stories can then be used for visual regression testing.

n/a

Interactive Component Playground

Storybook provides an interactive playground for your components, allowing you to manipulate props, check accessibility, and play with the component's state.

n/a

Other packages similar to storybook

react-styleguidist

React Styleguidist is a component development environment with a hot-reloaded dev server. It's similar to Storybook but focuses more on living style guides, and it uses Markdown for documentation.

docz

Docz leverages MDX to bring Markdown and JSX together into one file, enabling easier documentation writing for your components. It's simpler to set up than Storybook but might not be as feature-rich.

playroom

Playroom allows you to simultaneously design across a variety of themes and screen sizes, powered by JSX and your own component library. It's different from Storybook in that it focuses on layout and design rather than component isolation.

README

Build bulletproof UI components faster

Storybook is a frontend workshop for building UI components and pages in isolation. Thousands of teams use it for UI development, testing, and documentation. Find out more at storybook.js.org!

Storybook

The storybook package contains Storybook's core. It includes:

• Storybook's CLI and development server
• Storybook's main UI (aka "the manager")
• Core functionality including component controls, toolbar controls, action logging, viewport control, and interaction debugger
• User-facing utility libraries such as storybook/test, theming, and viewport
• Libraries used by Storybook's ecosystem of frameworks, addons, and builders

It also contains a variety of other libraries and utilities under the stroybook/internal namespace, such as utilities for CSF, MDX & Docs.

Learn more about Storybook at storybook.js.org.

Changelog

9.1.10

• Automigrations: Add automigration for viewport and backgrounds - #31614, thanks @valentinpalkovic!
• Telemetry: Log userAgent in onboarding - #32566, thanks @shilman!