Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion clients/storybook/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,18 @@ npm install @vizzly-testing/storybook

The plugin is automatically discovered by the Vizzly CLI via the `@vizzly-testing/*` scope.

## Storybook 10 Compatibility

The plugin works with the current stable Storybook 10 release. If you're upgrading an existing
Storybook app to the latest major, keep these Storybook 10 requirements in mind:

- `.storybook/main.js|ts` and related presets must be valid ESM
- Storybook 10 requires Node `20.19+` or `22.12+`
- `@storybook/addon-essentials` is zero-config in Storybook 10, so many apps no longer need to
list it explicitly in `addons`

Storybook's official migration guide: https://storybook.js.org/docs/releases/migration-guide

## Quick Start

### CLI Usage
Expand Down Expand Up @@ -137,7 +149,7 @@ Configuration is merged in this order (later overrides earlier):
- `--include <pattern>` - Include story pattern (glob)
- `--exclude <pattern>` - Exclude story pattern (glob)
- `--config <path>` - Path to custom config file
- `--browser-args <args>` - Additional Puppeteer browser arguments
- `--browser-args <args>` - Additional Playwright browser arguments
- `--headless` - Run browser in headless mode (default: true)
- `--full-page` - Capture full page screenshots (default: true)
- `--no-full-page` - Capture viewport-only screenshots
Expand Down
2 changes: 1 addition & 1 deletion clients/storybook/example-storybook/.storybook/main.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
export default {
stories: ['../src/**/*.stories.@(js|jsx|ts|tsx)'],
addons: ['@storybook/addon-essentials'],
addons: [],
framework: {
name: '@storybook/react-vite',
options: {},
Expand Down
Loading
Loading