Storybook

Type:

{
  builder?: string | { name: string; options?: BuilderOptions };
  channelOptions?: ChannelOptions;
  crossOriginIsolated?: boolean;
  disableProjectJson?: boolean;
  disableTelemetry?: boolean;
  disableWebpackDefaults?: boolean;
  disableWhatsNewNotifications?: boolean;
  enableCrashReports?: boolean;
  renderer?: RendererName;
}

Configures Storybook's internal features.

`builder`

Type:

| '@storybook/builder-vite' | '@storybook/builder-webpack5'
| {
    name: '@storybook/builder-vite' | '@storybook/builder-webpack5';
    options?: BuilderOptions;
  }

Configures Storybook's builder, Vite or Webpack.

With the new Framework API, framework.options.builder is now the preferred way to configure the builder.

You should only use core.builder.options if you need to configure a builder that is not part of a framework.

Code Snippets

Oh no! We could not find the code you are looking for.

It would be great if you could report an issue on Github if you see that message.

`channelOptions`

Type: ChannelOptions

{
  allowClass: boolean;
  allowDate: boolean;
  allowFunction: boolean;
  allowRegExp: boolean;
  allowSymbol: boolean;
  allowUndefined: boolean;
  lazyEval: boolean;
  maxDepth: number;
  space: number | undefined;
}

Configures the channel used by Storybook to communicate between the manager and preview.

Only two properties are likely to be used:

`channelOptions.allowFunction`

Type: boolean

Default: false

Enables serializing functions across the channel, which can be a security risk.

`channelOptions.maxDepth`

Type: number

Default: 3

The maximum depth of nested objects to serialize across the channel. Larger values will be slower.

`crossOriginIsolated`

Type: boolean

Enable CORS headings to run document in a "secure context". See SharedArrayBuffer security requirements

This enables these headers in development-mode:

Cross-Origin-Opener-Policy: same-origin
Cross-Origin-Embedder-Policy: require-corp

Code Snippets

Oh no! We could not find the code you are looking for.

It would be great if you could report an issue on Github if you see that message.

`disableProjectJson`

Type: boolean

Disables the generation of project.json, a file containing Storybook metadata

Code Snippets

Oh no! We could not find the code you are looking for.

It would be great if you could report an issue on Github if you see that message.

`disableTelemetry`

Type: boolean

Disables Storybook's telemetry collection.

Code Snippets

Oh no! We could not find the code you are looking for.

It would be great if you could report an issue on Github if you see that message.

`disableWebpackDefaults`

Type: boolean

Disables Storybook's default Webpack configuration.

Code Snippets

Oh no! We could not find the code you are looking for.

It would be great if you could report an issue on Github if you see that message.

`disableWhatsNewNotifications`

Type: boolean

Disables the "What's New" notifications in the UI for new Storybook versions and ecosystem updates (e.g., addons, content, etc.).

Code Snippets

Oh no! We could not find the code you are looking for.

It would be great if you could report an issue on Github if you see that message.

`enableCrashReports`

Type: boolean

Enable crash reports to be sent to Storybook telemetry.

Code Snippets

Oh no! We could not find the code you are looking for.

It would be great if you could report an issue on Github if you see that message.

`renderer`

Type: RendererName