| title | sidebar | ||||
|---|---|---|---|---|---|
build |
|
Parent: main.js|ts configuration
Type: TestBuildConfig
Provides configuration options to optimize Storybook's production build output.
Type: TestBuildFlags
{
disableBlocks?: boolean;
disabledAddons?: string[];
disableMDXEntries?: boolean;
disableAutoDocs?: boolean;
disableDocgen?: boolean;
disableSourcemaps?: boolean;
disableTreeShaking?: boolean;
}Configures Storybook's production builds for performance testing purposes by disabling certain features from the build. When running build-storybook, this feature is enabled by setting the --test flag.
The options documented on this page are automatically enabled when the --test flag is provided to the storybook build command. We encourage you to override these options only if you need to disable a specific feature for your project or if you are debugging a build issue.
Type: boolean
Excludes the @storybook/blocks package from the build, which generates automatic documentation with Docs Blocks.
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
Type: string[]
Sets the list of addons that will disabled in the build output.
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
Type: boolean
Enabling this option removes user-written documentation entries in MDX format from the build.
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
Type: boolean
Prevents automatic documentation generated with the autodocs feature from being included in the build.
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
Type: boolean
Disables automatic argType and component property inference with any of the supported static analysis tools based on the framework you are using.
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
Type: boolean
Overrides the default behavior of generating source maps for the build.
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
Type: boolean
Disables tree shaking in the build.
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}