hub / github.com/storybookjs/storybook

github.com/storybookjs/storybook @v10.4.6 sqlite

repository ↗ · DeepWiki ↗ · release v10.4.6 ↗

9,678 symbols 31,178 edges 3,454 files 622 documented · 6%

README

  <img src="https://user-images.githubusercontent.com/321738/63501763-88dbf600-c4cc-11e9-96cd-94adadc2fd72.png" alt="Storybook" width="400" />

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!

View README for:

🚀 Getting Started
📒 Projects
🛠 Supported Frameworks & Examples
🔗Addons
🏅 Badges & Presentation materials
👥 Community
👏 Contributing
👨‍💻 Development scripts
💸 Sponsors
💵 Backers
:memo: License

Getting Started

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

Documentation

Documentation can be found on Storybook's docs site.

Examples

View Component Encyclopedia to see how leading teams use Storybook.

Use storybook.new to quickly create an example project in Stackblitz.

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.

Community

For additional help, share your issue in the repo's GitHub Discussions.

Projects

Supported Frameworks

Renderer	Demo
React
Angular
Vue 3
Web components
React Native
HTML
Ember
Svelte
Preact
Qwik
SolidJS
Android, iOS, Flutter

Addons

Addons
a11y	Test components for user accessibility in Storybook
actions	Log actions as users interact with components in the Storybook UI
backgrounds	Let users choose backgrounds in the Storybook UI
cssresources	Dynamically add/remove CSS resources to the component iframe
design assets	View images, videos, and weblinks alongside your story
docs	Add high quality documentation to your components
events	Interactively fire events to components that respond to EventEmitter
google-analytics	Reports google analytics on stories
graphql	Query a GraphQL server within Storybook stories
jest	View the results of components' unit tests in Storybook
links	Create links between stories
measure	Visually inspect the layout and box model within the Storybook UI
outline	Visually debug the CSS layout and alignment within the Storybook UI
query params	Mock query params
viewport	Change display sizes and layouts for responsive components using Storybook

See Addon / Framework Support Table

To continue improving your experience, we have to eventually deprecate or remove 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.

If you're using addon-storyshots, we highly recommend you migrate to the Storybook test-runner 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 t

Extension points exported contracts — how you extend this code

AgentDriver (Interface)

(no doc) [8 implementers]

scripts/eval/lib/agents/config.ts

ChannelTransport (Interface)

(no doc) [5 implementers]

code/core/src/channels/types.ts

Page (Interface)

* Copied from: * {@link https://github.com/sveltejs/kit/blob/7bb41aa4263b057a8912f4cdd35db03755d37342/packages/kit/type

code/frameworks/sveltekit/src/types.ts

UpgradeConfig (Interface)

Configuration for upgrading Storybook dependencies

code/lib/cli-storybook/src/util.ts

AutomockLoaderOptions (Interface)

Defines the options that can be passed to the webpack-automock-loader.

code/builders/builder-webpack5/src/loaders/webpack-automock-loader.ts

MaybeAstAttribute (Interface)

Loose shape of a single attribute node from the Svelte AST (`Attribute[]` on `Script`).

code/renderers/svelte/src/parsers/svelteImportParser.ts

Chainable (Interface)

(no doc)

test-storybooks/portable-stories-kitchen-sink/react/cypress/support/component.ts

AccountFormResponse (Interface)

(no doc)

test-storybooks/external-docs/components/AccountForm.tsx

Core symbols most depended-on inside this repo

expect

called by 10167

test-storybooks/ember-cli/ember-output/assets/vendor.js

join

called by 897

test-storybooks/ember-cli/ember-output/assets/vendor.js

get

called by 638

code/core/src/types/modules/core-common.ts

called by 521

code/core/src/test/spy.ts

resolve

called by 447

code/core/src/core-server/change-detection/dependency-graph/ResolverFactory.ts

log

called by 444

code/core/src/node-logger/logger/console.ts

set

called by 408

code/core/src/common/utils/file-cache.ts

emit

called by 368

code/core/src/channels/types.ts

Shape

Function 6,545

Method 1,267

Interface 1,164

Class 647

Enum 55

Languages

TypeScript100%

Modules by API surface

test-storybooks/ember-cli/ember-output/assets/vendor.js1,345 symbols

code/core/src/server-errors.ts111 symbols

code/addons/docs/src/blocks/controls/react-editable-json-tree/JsonNodes.tsx77 symbols

scripts/eval/collect-pr-data.ts66 symbols

code/core/src/preview-errors.ts64 symbols

code/core/src/csf-tools/ConfigFile.ts51 symbols

code/core/src/csf-tools/CsfFile.ts46 symbols

scripts/eval/lib/result-docs.ts45 symbols

code/renderers/react/src/componentManifest/componentMeta/componentMetaExtractor.ts41 symbols

scripts/eval/run-batch.ts40 symbols

code/core/src/types/modules/core-common.ts39 symbols

code/core/src/preview-api/modules/addons/hooks.ts38 symbols

Used by 91 indexed graphs manifest dependencies, hub-wide

github.com/4ian/GDevelop

github.com/CapSoftware/Cap

github.com/CopilotKit/CopilotKit

github.com/HamishMW/portfolio

github.com/Kilo-Org/kilocode

github.com/MetaMask/metamask-extension

github.com/OpenHands/OpenHands

github.com/PrefectHQ/prefect

github.com/QwenLM/qwen-code

github.com/QwikDev/qwik

… +81 more

Dependencies from manifests, versioned

@actions/core1.11.1 · 1×

@analogjs/vite-plugin-angular1.12.1 · 1×

@angular-devkit/architect0.1901.1 · 1×

@angular-devkit/build-angular19.1.1 · 1×

@angular-devkit/core19.1.1 · 1×

@angular/animations19.1.1 · 1×

@angular/common19.1.1 · 1×

@angular/compiler19.1.1 · 1×

@angular/compiler-cli19.1.1 · 1×

@angular/core19.1.1 · 1×

@angular/forms19.1.1 · 1×

@angular/platform-browser19.1.1 · 1×

For agents

$ claude mcp add storybook \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact