storybook/docs/api/main-config-framework.md
2023-11-26 16:11:45 +00:00

1.8 KiB

title
framework

(Required)

Parent: main.js|ts configuration

Type: FrameworkName | { name: FrameworkName; options?: FrameworkOptions }

Configures Storybook based on a set of framework-specific settings.

<CodeSnippets paths={[ 'common/main-config-framework.js.mdx', 'common/main-config-framework.ts.mdx', ]} />

name

Type: string

For available frameworks and their options, see their respective documentation.

options

Type: Record<string, any>

While many options are specific to a framework, there are some options that are shared across some frameworks, e.g. those that configure Storybook's builder.

options.builder

Type: Record<string, any>

Configures Storybook's builder, Vite or Webpack.

options.builder.useSWC

For frameworks made with Webpack builder, except Angular. Enabling this option allows you to use the SWC compiler instead of Babel.

When Storybook loads, it will update Webpack's configuration including the required loaders (e.g., TerserPlugin, babel-loader) with SWC equivalents (e.g., swc-loader) for bundling and minification.

<CodeSnippets paths={[ 'common/main-config-framework-options-builder-use-swc.js.mdx', 'common/main-config-framework-options-builder-use-swc.ts.mdx', ]} />