storybook/docs/api/main-config-framework.md
Kyle Gach 852cc70c13 Move "experimental" label beneath heading
- To avoid it being part of the heading anchor
    - Helps links to anchor stay stable over time, when label is removed
2023-06-09 15:24:03 -06:00

1.8 KiB

title
framework

Parent: main.js|ts configuration

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

Required: true

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

(⚠️ Experimental)

For frameworks made with the Webpack builder, 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', ]} />