npm i @storybook/angular


Storybook is a frontend workshop for building UI components and pages in isolation. Made for UI development, testing, and documentation.

by storybookjs

6.5.16 (see all)License:MITTypeScript:Built-In
npm i @storybook/angular


Build bulletproof UI components faster

Build Status on CircleCI codecov License
Storybook Community Backers on Open Collective Sponsors on Open Collective Official Twitter Handle OpenSSF Scorecard

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 https://storybook.js.org.

View README for:
latest next future

Table of contents

Getting Started

Visit Storybook's website to learn more about Storybook and to get started.


Documentation can be found on Storybook's docs site.


View Component Encyclopedia to see how leading teams use Storybook.

Storybook comes with a lot of addons for component design, documentation, testing, interactivity, and so on. Storybook's API makes it possible to configure and extend in various ways. It has even been extended to support React Native, Android, iOS, and Flutter development for mobile.


For additional help, join us in the Storybook Discord.


Supported Frameworks

?TODO, the link below will breakReact
ReactStorybook demoReact
VueStorybook demoVue
AngularStorybook demoAngular
Web componentsStorybook demoSvelte
React Native-React Native
HTMLStorybook demoHTML
EmberStorybook demoEmber
SvelteStorybook demoSvelte
PreactStorybook demoPreact
Android, iOS, FlutterStorybook demoNative

Sub Projects

  • CLI - Streamlined installation for a variety of app types
  • examples - Code examples to illustrate different Storybook use cases


a11yTest components for user accessibility in Storybook
actionsLog actions as users interact with components in the Storybook UI
backgroundsLet users choose backgrounds in the Storybook UI
cssresourcesDynamically add/remove CSS resources to the component iframe
design assetsView images, videos, and weblinks alongside your story
docsAdd high quality documentation to your components
eventsInteractively fire events to components that respond to EventEmitter
google-analyticsReports google analytics on stories
graphqlQuery a GraphQL server within Storybook stories
jestView the results of components' unit tests in Storybook
linksCreate links between stories
measureVisually inspect the layout and box model within the Storybook UI
outlineVisually debug the CSS layout and alignment within the Storybook UI
query paramsMock query params
storyshotsSnapshot testing for components in Storybook
storysourceView the code of your stories within the Storybook UI
viewportChange display sizes and layouts for responsive components using Storybook

See Addon / Framework Support Table

Deprecated Addons

contextsAddon for driving your components under dynamic contexts
infoAnnotate stories with extra component usage information
knobsInteractively edit component prop data in the Storybook UI
notesAnnotate Storybook stories with notes
optionsCustomize the Storybook UI in code

To continue improving your experience, we have to eventually deprecate certain addons in favor of new and better tools.

If you're using info/notes, we highly recommend you migrate to docs instead, and here is a guide to help you.

If you're using contexts, we highly recommend you migrate to toolbars and here is a guide to help you.

Badges & Presentation materials

We have a badge! Link it to your live Storybook example.


[![Storybook](https://cdn.jsdelivr.net/gh/storybookjs/brand@main/badge/badge-storybook.svg)](link to site)

If you're looking for material to use in your Storybook presentation, such as logos, video material, and the colors we use, you can find it all on our brand repo.



Contributions to Storybook are always welcome!

  • 📥 Pull requests and 🌟 Stars are always welcome.
  • Read our contributing guide to get started, or find us on Discord, we will take the time to guide you.

Looking for a first issue to tackle?

  • We tag issues with Good First Issue when we think they are well suited for people who are new to the codebase or OSS in general.
  • Talk to us, we'll find something that suits your skills and learning interest.

Development scripts

Storybook is organized as a monorepo using Lerna. Useful scripts include:

yarn start

Runs a sandbox template storybook with test stories

yarn task

As above, but gives you options to customize the sandbox (e.g. selecting other frameworks)

yarn lint

boolean check if code conforms to linting rules - uses remark & eslint

  • yarn lint:js - will check js
  • yarn lint:md - will check markdown + code samples
  • yarn lint:js --fix - will automatically fix js

yarn test

boolean check if unit tests all pass - uses jest

  • yarn run test --core --watch - will run core tests in watch-mode


Become a sponsor to have your logo and website URL on our README on Github. [Become a sponsor]


By making a recurring donation, you can support us and our work. [Become a backer]



-the end-