@nrwl/storybook

What is @nrwl/storybook?

@nrwl/storybook is an npm package that integrates Storybook with Nx, a set of extensible dev tools for monorepos. It allows you to build, test, and manage UI components in isolation, making it easier to develop and maintain large-scale applications.

What are @nrwl/storybook's main functionalities?

Setup Storybook in an Nx Workspace

This command sets up Storybook for a specific library within an Nx workspace. It configures the necessary files and dependencies to get Storybook up and running.

npx nx g @nrwl/react:storybook-configuration my-lib

Generate Stories for Components

This command generates Storybook stories for a specific component. It helps in quickly creating stories that can be used to visualize and test the component in isolation.

npx nx g @nrwl/react:component-story --componentPath=libs/my-lib/src/lib/my-component.tsx

Run Storybook

This command starts the Storybook server for a specific library, allowing you to view and interact with your components in the Storybook UI.

npx nx run my-lib:storybook

Build Storybook

This command builds a static version of your Storybook, which can be deployed to a static site hosting service. It is useful for sharing your component library with others.

npx nx run my-lib:build-storybook

Other packages similar to @nrwl/storybook

storybook

Storybook is the core package for building UI components in isolation. While @nrwl/storybook integrates Storybook with Nx, the core Storybook package can be used independently or with other frameworks and build tools.

react-styleguidist

React Styleguidist is a component development environment with a focus on React components. It provides a similar functionality to Storybook but with a different approach to documentation and component visualization.

docz

Docz is a tool for creating documentation for React components with a focus on simplicity and ease of use. It offers a different set of features compared to Storybook, with a stronger emphasis on documentation.

README

@nrwl/storybook has been renamed to @nx/storybook!

@nrwl/storybook has been renamed to @nx/storybook. Please use that instead.

Read more here

@nrwl/storybook will no longer be published in the future.

Nx: Smart Monorepos · Fast CI

Nx is a build system, optimized for monorepos, with plugins for popular frameworks and tools and advanced CI capabilities including caching and distribution.