storybook/docs/get-started/svelte-webpack5.md

title
Storybook for Svelte & Webpack

export const SUPPORTED_RENDERER = 'svelte';

Storybook for Svelte & Webpack is a framework that makes it easy to develop and test UI components in isolation for applications using Svelte built with Webpack.

Storybook for Svelte & Webpack is only supported in Svelte projects.

Requirements

• Svelte ≥ 4.0
• Webpack ≥ 5.0
• Storybook ≥ 8.0

Getting started

In a project without Storybook

Follow the prompts after running this command in your Svelte project's root directory:

<CodeSnippets paths={[ 'common/init-command.npx.js.mdx', 'common/init-command.yarn.js.mdx', 'common/init-command.pnpm.js.mdx', ]} />

More on getting started with Storybook.

In a project with Storybook

This framework is designed to work with Storybook 7+. If you’re not already using v7, upgrade with this command:

<CodeSnippets paths={[ 'common/storybook-upgrade.npm.js.mdx', 'common/storybook-upgrade.pnpm.js.mdx', 'common/storybook-upgrade.yarn.js.mdx' ]} />

Automatic migration

When running the upgrade command above, you should get a prompt asking you to migrate to @storybook/svelte-webpack5, which should handle everything for you. In case that auto-migration does not work for your project, refer to the manual migration below.

Manual migration

First, install the framework:

<CodeSnippets paths={[ 'svelte/svelte-webpack5-install.npm.js.mdx', 'svelte/svelte-webpack5-install.pnpm.js.mdx', 'svelte/svelte-webpack5-install.yarn.js.mdx' ]} />

Next, install and register your appropriate compiler addon, depending on whether you're using SWC (recommended) or Babel:

<CodeSnippets paths={[ 'common/storybook-addon-compiler-swc-auto-install.npm.js.mdx', 'common/storybook-addon-compiler-swc-auto-install.pnpm.js.mdx', 'common/storybook-addon-compiler-swc-auto-install.yarn.js.mdx', ]} />

or

<CodeSnippets paths={[ 'common/storybook-addon-compiler-babel-auto-install.npm.js.mdx', 'common/storybook-addon-compiler-babel-auto-install.pnpm.js.mdx', 'common/storybook-addon-compiler-babel-auto-install.yarn.js.mdx', ]} />

More details can be found in the Webpack builder docs.

Finally, update your .storybook/main.js|ts to change the framework property:

<CodeSnippets paths={[ 'svelte/svelte-webpack5-add-framework.js.mdx', 'svelte/svelte-webpack5-add-framework.ts.mdx' ]} />

Writing native Svelte stories

Storybook provides a Svelte addon maintained by the community, enabling you to write stories for your Svelte components using the template syntax. You'll need to take some additional steps to enable this feature.

Run the following command to install the addon.

<CodeSnippets paths={[ 'svelte/svelte-csf-addon-install.yarn.js.mdx', 'svelte/svelte-csf-addon-install.npm.js.mdx', 'svelte/svelte-csf-addon-install.pnpm.js.mdx', ]} />

The community actively maintains the Svelte CSF addon but still lacks some features currently available in the official Storybook Svelte framework support. For more information, see the addon's documentation.

API

Options

You can pass an options object for additional configuration if needed:

// .storybook/main.js
import * as path from 'path';

export default {
  // ...
  framework: {
    name: '@storybook/svelte-webpack5',
    options: {
      // ...
    },
  },
};

The available options are:

builder

Type: Record<string, any>

Configure options for the framework's builder. For this framework, available options can be found in the Webpack builder docs.