storybook
Advanced tools
Storybook's CLI - install, dev, build, upgrade, and more
Package description
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.
UI Component Exploration
Developers can browse through the components and their different states to understand how components look and feel in isolation.
n/aUI Component Documentation
Storybook allows developers to create documentation for each component, which can include usage instructions, design notes, and other important information.
n/aVisual 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/aInteractive 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/aReact 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 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.
Pattern Lab is a static site generator that stitches together UI components. While it's not as interactive as Storybook, it's a good tool for creating design systems.
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
Storybook CLI (Command Line Interface) is the easiest way to add Storybook to your project.
Go to your project and run:
cd my-app
npx sb@latest init
In addition to init, the CLI also has other commands:
add - add an addon and register itinfo - print out system information for bug reportsupgrade - upgrade to the latest version of Storybook (or a specific version)migrate - run codemods to migrate your codeSee the command-line help with -h (including other useful commands) for details.
This package has multiple sub-exports to can be used to gain access to storybook's APIs.
storybook/componentsThis export contains a list of components very useful for building out addons. We recommend addon-authors to use these components to ensure a consistent look and feel, and to reduce the amount of code they need to write.
storybook/themingThis export exposes a few utility functions to help writing components that automatically adapt to the current theme. Useful for addon authors who want to make their addons theme-aware.
storybook/preview-apiThis export contains the API that is available in the preview iframe.
storybook/manager-apiThis export contains the API that is available in the manager iframe.
storybook/typesThis export exposes a lot of TypeScript interfaces used throughout storybook, including for storybook configuration, addons etc.
FAQs
Storybook's CLI - install, dev, build, upgrade, and more
The npm package storybook receives a total of 3,682,279 weekly downloads. As such, storybook popularity was classified as popular.
We found that storybook demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Git dependencies in open source packages can introduce significant risks, including lack of version control, stability issues, dependency drift, and difficulty in auditing, making them potential targets for supply chain attacks.
Security News
Node.js has added experimental support for TypeScript, a move that highlights the growing importance of TypeScript in modern development.
Product
Check out what's new at Socket with our Product Changelog. It tracks all public-facing updates, improvements, and fixes so you can take full advantage of our features.