Repository: storybookjs/storybook

Stars: 89728

.cursorrules

Test Configuration

This Storybook repository uses Vitest as the test runner. Here are the key commands and configuration:

Test Scripts

- yarn test - Run all tests (from root directory, delegates to cd code; yarn test)
- yarn test <test-name> - Run focused tests matching the pattern
- yarn test:watch - Run tests in watch mode
- yarn test:watch <test-name> - Run focused tests in watch mode

Test Directory Structure

- Tests are located in the code/ directory
- Vitest configuration is in code/vitest.workspace.ts
- Test files typically follow the pattern .test.ts, .test.tsx, .spec.ts, or .spec.tsx

Running Tests in Cursor

1. Use Cmd+Shift+P (or Ctrl+Shift+P) and search for "Tasks: Run Task"
2. Select from the available test tasks:
- "Run All Tests" - Runs all tests
- "Run Test (Watch Mode)" - Runs tests in watch mode
- "Run Focused Test" - Prompts for test name/pattern to run specific tests
- "Run Focused Test (Watch Mode)" - Runs specific tests in watch mode

Vitest Configuration

- Workspace configuration: ./code/vitest.workspace.ts
- Command line: yarn --cwd code test
- Root directory for tests: ./code/

Test Execution Context

- Tests run from the code/ directory
- Use NODE_OPTIONS=--max_old_space_size=4096 for memory optimization
- Supports both watch mode and single-run execution

Focused Test Patterns

When running focused tests, you can use:

- File names: Button.test.ts
- Test descriptions: "should render correctly"
- Directory patterns: components/
- Vitest patterns: -t "pattern" for test name matching

Test Mocking Rules

Follow the spy mocking rules defined in .cursor/rules/spy-mocking.mdc for consistent mocking patterns with Vitest.

CLAUDE.md

@AGENTS.md

README.md

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 <a href="https://storybook.js.org/?ref=readme">storybook.js.org</a>!

View README for: 
<a href="https://github.com/storybookjs/storybook/blob/main/README.md" title="latest"><img alt="latest" src="https://img.shields.io/npm/v/@storybook/react/latest?style=for-the-badge&logo=storybook&logoColor=ffffff&color=66BF3C" /></a>
<a href="https://github.com/storybookjs/storybook/blob/next/README.md" title="next"><img alt="next" src="https://img.shields.io/npm/v/@storybook/react/next?style=for-the-badge&logo=storybook&logoColor=ffffff&color=1EA7FD" /></a>

- 🚀 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 | ![Storybook demo](https://next--630511d655df72125520f051.chromatic.com/) | ![React](code/renderers/react) |
| Angular | ![Storybook demo](https://next--6322ce6af69825592bbb28fc.chromatic.com/) | ![Angular](code/frameworks/angular/) |
| Vue 3 | ![Storybook demo](https://next--630513346a8e284ae244d415.chromatic.com/) | ![Vue 3](code/renderers/vue3/) |
| Web components | ![Storybook demo](https://next--638db5bf49adfdfe8cf545e0.chromatic.com/) | ![Svelte](code/renderers/web-components) |
| React Native | ![](/) | ![React Native](https://github.com/storybookjs/react-native) |
| HTML | ![Storybook demo](https://next--63dd39a158cf6fc05199b4bb.chromatic.com/) | ![HTML](code/renderers/html) |
| Ember | ![](/) | ![Ember](code/frameworks/ember/) |
| Svelte | ![Storybook demo](https://next--630873996e4e3557791c069c.chromatic.com/) | ![Svelte](code/renderers/svelte) |
| Preact | ![Storybook demo](https://next--63b588a512565bfaace15e7c.chromatic.com/) | ![Preact](code/renderers/preact) |
| Qwik | ![](/) | ![Qwik](https://github.com/literalpie/storybook-framework-qwik) |
| SolidJS | ![](/) | ![SolidJS](https://github.com/solidjs-community/storybook) |
| Android, iOS, Flutter | ![](/) | ![Native](https://github.com/storybookjs/native) |

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

![Storybook](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.

Community

- Tweeting via @storybookjs
- Blogging at storybook.js.org and Medium
- Chatting on Discord
- Videos and streams at YouTube

Contributing

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](https://github.com/storybookjs/storybook/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) 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 interests.

Development scripts

Storybook is organized as a monorepo. 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

Sponsors

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

Backers

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

License

MIT

-the end-

Repository: storybookjs/storybook

Stars: 89728

.cursorrules Copy Chapter

Test Configuration Copy Chapter

Test Scripts Copy Section

Test Directory Structure Copy Section

Running Tests in Cursor Copy Section

Vitest Configuration Copy Section

Test Execution Context Copy Section

Focused Test Patterns Copy Section

Test Mocking Rules Copy Section

CLAUDE.md Copy Chapter

README.md Copy Chapter

Table of contents Copy Chapter

Getting Started Copy Chapter

Documentation Copy Section

Examples Copy Section

Community Copy Section

Projects Copy Chapter

Supported Frameworks Copy Section

Addons Copy Section

Badges & Presentation materials Copy Chapter

Community Copy Chapter

Contributing Copy Chapter

Development scripts Copy Section

Sponsors Copy Section

Backers Copy Section

License Copy Chapter

.cursorrules

Test Configuration

Test Scripts

Test Directory Structure

Running Tests in Cursor

Vitest Configuration

Test Execution Context

Focused Test Patterns

Test Mocking Rules

CLAUDE.md

README.md

Table of contents

Getting Started

Documentation

Examples

Community

Projects

Supported Frameworks

Addons

Badges & Presentation materials

Community

Contributing

Development scripts

Sponsors

Backers

License