sb-addon-vue-csf

KO | EN

gitlite — search

#javascript #hacktoberfest #react #typescript #android #rust #docker #windows #awesome #cli #vue #security #openai #open-source

sb-addon-vue-csf

(★ 40)

Write Storybook stories in Vue Single File Component syntax.

sb-addon-vue-csf Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# sb-addon-vue-csf

This Storybook addon allows you to write Storybook stories using Vue Single File Component syntax instead of ESM that regular CSF is based on.

```bash
npx storybook@latest add sb-addon-vue-csf
```

Using Vue SFC syntax makes it easier to write stories for Vue components with proper template support, slots, and composition patterns.

## 🐣 Getting Started

> [!TIP]
> If you've initialized your Storybook project with Storybook version 8.2.0 or above, this addon may already be available for Vue projects!

> [!IMPORTANT]
> Not running the latest versions of Storybook or Vue? Be sure to check [the version compatibility section below](#version-compatibility).

### Installation

The easiest way to install the addon is with `storybook add`:

```bash
npx storybook@latest add sb-addon-vue-csf
```

You can also add the addon manually. First, install the package:

```bash
npm install --save-dev sb-addon-vue-csf
```

Then modify your `.storybook/main.ts` Storybook configuration to include the addon and include `*.stories.vue` files:

```diff
export default {
-  stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],
+  stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx|vue)'],
  addons: [
+    'sb-addon-vue-csf',
    ...
  ],
  ...
}
```

Restart your Storybook server for the changes to take effect.

## 🐓 Usage

> [!NOTE]
> The documentation here does not cover all of Storybook's features, only the aspects that are specific to the addon and Vue CSF. We recommend that you familiarize yourself with [Storybook's core concepts](https://storybook.js.org/docs).

The [`examples`](./examples/) directory contains examples describing each feature of the addon. The [`Button.stories.vue` example](./examples/Button.stories.vue) is a good one to get started with.

Vue CSF stories files must always have the `.stories.vue` extension.

### Defining the meta

All stories files must have a "meta" (aka. "default export") defined, and its structure follows what's described in [the official docs on the subject](https://storybook.js.org/docs/api/csf#default-export). To define the meta in Vue CSF, call the `defineMeta` function **within the script setup**, with the meta properties you want:

```vue
<script setup lang="ts">
import { defineMeta } from 'sb-addon-vue-csf';
import MyComponent from './MyComponent.vue';

//      👇 Get the Story component from the return value
const { Story } = defineMeta({
  title: 'Path/To/MyComponent',
  component: MyComponent,
  decorators: [
    /* ... */
  ],
  parameters: {
    /* ... */
  },
});
</script>
```

`defineMeta` returns an object with a `Story` component (see [Defining stories](#defining-stories) below) that you must destructure out to use.

### Defining stories

To define stories, you use the `Story` component returned from the `defineMeta` function. All properties of [a regular CSF story](https://storybook.js.org/docs/api/csf#named-story-exports) are passed as props to the `Story` component.

All story requires either the `name` prop or `exportName` prop.

#### Plain Story

If your component only accepts props and doesn't require slots, you can use the simple form of defining stories, only using args:

```vue
<template>
  <Story name="Primary" :args="{ primary: true }" />
</template>
```

This will render the component defined in the meta, with the args passed as props.

#### With children (default slot)

If your component needs children, you can pass them in directly to the story:

```vue
<template>
  <Story name="With Children">
    I will be the child of the component from defineMeta
  </Story>
</template>
```

#### Static template (asChild)

If you need more customization of the story, like composing components, you can set the `asChild` prop on the Story. Instead of forwarding the children to your component, it will instead use the children directly as the story output:

```vue
<template>
  <Story name="Composed" asChild>
    <MyComponent>
      <AChild label="Hello world!" />
    </MyComponent>
  </Story>
</template>
```

> [!IMPORTANT]
> This format completely ignores args, as they are not passed down to any of the child components defined. Even if your story has args and Controls, they won't have an effect.

#### With template slot

If you need composition but also want a dynamic story that reacts to args, you can define a template slot in the `Story` component:

```vue
<template>
  <Story name="Simple Template" :args="{ simpleChild: true }">
    <template #template="{ args, context }">
      <MyComponent v-bind="args">Component with args</MyComponent>
    </template>
  </Story>
</template>
```

#### Default template at meta level

If you only need a single template that you want to share among multiple stories, define it at the meta level:

```vue
<script setup lang="ts">
import { defineMeta } from 'sb-addon-vue-csf';
import MyComponent from './MyComponent.vue';

const { Story } = defineMeta({
  title: 'MyComponent',
  component: MyComponent,
  render: template,
});

// Define the default template
function template(args) {
  return {
    components: { MyComponent },
    setup() {
      return { args };
    },
    template: '<MyComponent v-bind="args" />',
  };
}
</script>

<template>
  <Story name="Primary" :args="{ variant: 'primary' }" />
  <Story name="Secondary" :args="{ variant: 'secondary' }" />
</template>
```

#### Reusable templates with `createReusableTemplate`

For more complex scenarios, you can use `createReusableTemplate` (re-exported from VueUse) combined with `createRenderTemplate` to define reusable templates. This pattern is useful when you need:

- Interactive state in your wrapper (like counters, toggles)
- Common layout wrappers with complex markup
- Access to Vue composition API within the template

**How it works:**
1. `createReusableTemplate()` creates a pair of components: `DefineTemplate` (to define the template content) and `ReuseTemplate` (to render it)
2. `createRenderTemplate(ReuseTemplate)` converts the `ReuseTemplate` component into a render function compatible with `defineMeta`
3. The template is defined in the `<template>` block using `<DefineTemplate>`

**Basic example:**

```vue
<script lang="ts">
// Module-level script for exports that need to be accessible to CSF
import { createReusableTemplate, createRenderTemplate } from 'sb-addon-vue-csf';
import Button from './Button.vue';

const [DefineTemplate, ReuseTemplate] = createReusableTemplate();
export const defaultTemplate = createRenderTemplate(ReuseTemplate);
</script>

<Story name="Primary" :args="{ primary: true }" />
  <Story name="Secondary" :args="{ label: 'Button' }" />
</template>
```

**Advanced example with state:**

```vue
<script lang="ts">
import { createReusableTemplate, createRenderTemplate } from 'sb-addon-vue-csf';
import Button from './Button.vue';

const [DefineWrapper, ReuseWrapper] = createReusableTemplate();
export const wrapperTemplate = createRenderTemplate(ReuseWrapper);
</script>

const { Story } = defineMeta({
  title: 'Example/InteractiveButton',
  component: Button,
  render: wrapperTemplate,
});

// Reactive state accessible within the template
const clickCount = ref(0);
</script>

<template>
  
  <DefineWrapper v-slot="{ args }">
    <div style="padding: 20px; background: #f0f9ff; border-radius: 8px;">
      <p style="margin: 0 0 10px;">Clicked {{ clickCount }} times</p>
      <Button
        v-bind="args"
        @click="clickCount++"
      />
    </div>
  </DefineWrapper>

<Story name="Default" :args="{ label: 'Click me' }" />
  <Story name="Primary" :args="{ primary: true, label: 'Click me too' }" />
</template>
```

**Key points:**
- Use the `<script lang="ts">` (module scope) to define exports like `defaultTemplate` - this makes them available for CSF exports
- Use `<script setup>` for your component logic, reactive state, and `defineMeta`
- The `DefineTemplate` component must be rendered in the template to register the template content
- Stories can still override the default template by providing their own `#template` slot

#### Custom export name

Behind-the-scenes, each `<Story />` definition is compiled to a variable export like `export const MyStory = ...;`. The variable names are simplifications of the story names - to make them valid JavaScript variables.

You can explicitly define the variable name of any story by passing the `exportName` prop:

```vue
<template>
  <Story exportName="MyStory1" name="my story!" />
  <Story exportName="MyStory2" name="My Story" />
</template>
```

At least one of the `name` or `exportName` props must be passed to the `Story` component - passing both is also valid.

### Play functions

You can define interaction tests using the `play` prop on the `Story` component:

```vue
<script setup lang="ts">
import { defineMeta } from 'sb-addon-vue-csf';
import { expect, within } from 'storybook/test';
import Button from './Button.vue';

const { Story } = defineMeta({
  title: 'Example/Button',
  component: Button,
});

async function playRendersTest({ canvasElement }: { canvasElement: HTMLElement }) {
  const canvas = within(canvasElement);
  const button = canvas.getByRole('button');
  expect(button).toBeInTheDocument();
}
</script>

<template>
  <Story
    name="WithPlayTest"
    :args="{ primary: true, label: 'Play Test Button' }"
    :play="playRendersTest"
  />
</template>
```

### TypeScript

Story template snippets can be type-safe when necessary. The type of the args are inferred from the `component` or `render` property passed to `defineMeta`.

```vue
<script setup lang="ts">
import { defineMeta } from 'sb-addon-vue-csf';
import type { ComponentProps } from 'vue-component-type-helpers';

import MyComponent from './MyComponent.vue';

const { Story } = defineMeta({
  component: MyComponent,
});

type Args = ComponentProps<typeof MyComponent>;
</script>

<template>
  <Story name="Primary" :args="{ primary: true }" />
</template>
```

Or using Vue's `SetupContext` types:

```vue
<script setup lang="ts">
import { defineMeta } from 'sb-addon-vue-csf';
import MyComponent from './MyComponent.vue';

const { Story } = defineMeta({
  component: MyComponent,
});
</script>

<template>
  <Story name="Primary" :args="{ primary: true }">
    <template #template="{ args }: { args: InstanceType<typeof MyComponent>['$props'] }">
      <MyComponent v-bind="args" />
    </template>
  </Story>
</template>
```

## API Reference

### `defineMeta(meta)`

Defines the metadata for a stories file.

**Parameters:**
- `meta` - Object containing Storybook meta properties:
  - `title` - The title/path for the component in Storybook
  - `component` - The component being documented
  - `subcomponents` - Record of related subcomponents
  - `decorators` - Array of decorators
  - `parameters` - Parameters object
  - `args` - Default args for all stories
  - `argTypes` - ArgTypes for controls
  - `tags` - Tags for the stories (e.g., `['autodocs']`)
  - `render` - Default render function for stories
  - `play` - Play function for all stories
  - `loaders` - Loaders for all stories
  - `globals` - Global parameters for all stories
  - `beforeEach` - Function to run before each story

**Returns:**
- Object with `Story` component that must be destructured and used in the template

### `createReusableTemplate()`

Creates a reusable template pair (DefineTemplate and ReuseTemplate). Re-exported from `@vueuse/core` for convenience.

**Returns:**
- A tuple `[DefineTemplate, ReuseTemplate]` for defining and reusing templates

### `createRenderTemplate(ReuseTemplate)`

Creates a render function for use with `defineMeta`'s render option.

**Parameters:**
- `ReuseTemplate` - The ReuseTemplate component from `createReusableTemplate()`

**Returns:**
- A render function compatible with `defineMeta`'s `render` option

### `<Story />` Props

- `name` - The name of the story (displayed in sidebar)
- `exportName` - The export name (used for the variable name in CSF)
- `args` - Args for the story (passed as props to component)
- `argTypes` - ArgTypes for this specific story
- `parameters` - Parameters for this story
- `tags` - Tags for this story (e.g., `['autodocs']`)
- `play` - Play function for interactions
- `loaders` - Loaders for this story
- `globals` - Global parameters for this story
- `decorators` - Decorators for this specific story
- `asChild` - When true, renders children directly without wrapping in the meta component

### `<Story />` Slots

- `default` - Default slot content (becomes children of the meta component)
- `template` - Template slot that receives `{ args, context }` for custom rendering

## Save from Controls

This addon supports Storybook's "Save from Controls" feature — when you modify args in the Controls panel, you can click **"Update story"** to write the changes back to your `.stories.vue` file, or **"Create new story"** to add a new `<Story>` tag.

This works out of the box with no extra configuration. The addon intercepts Storybook's save requests for `.stories.vue` files and handles them with Vue-aware parsing (using `@vue/compiler-sfc`) instead of the default Babel-based handler which only supports JS/TS files.

**Behavior:**
- **Update story**: Merges the new args with existing `:args` on the `<Story>` tag, preserving any values you didn't change
- **Create new story**: Inserts a new `<Story>` tag after the source story with the specified name and args

## How it works

Vue CSF uses a Vite plugin to transform `.stories.vue` files into standard CSF format that Storybook can understand:

1. **Parser** (`src/parser/`): Uses `@vue/compiler-sfc` to parse Vue SFC files and extract `defineMeta` calls and `Story` components
2. **Compiler** (`src/compiler/`): Vite plugins transform the compiled Vue code into valid CSF exports
3. **Indexer** (`src/indexer/`): Discovers stories in `.stories.vue` files for Storybook's sidebar
4. **Runtime** (`src/runtime/`): Vue components (`Story.vue`, `StoryRenderer.vue`) handle rendering
5. **Save Story** (`src/save-story/`): Handles "Save from Controls" by intercepting `saveStoryRequest` via `experimental_serverChannel` and updating `.stories.vue` files with Vue-aware parsing

See [ARCHITECTURE.md](./ARCHITECTURE.md) for detailed architecture documentation.

## Version Compatibility

### latest

| Dependency | Version |
| ---------- | ------- |
| [Storybook](https://github.com/storybookjs/storybook) | `^8.2.0 \|\| ^9.0.0 \|\| ^10.0.0` |
| [Vue](https://github.com/vuejs/core) | `^3.0.0` |
| [Vite](https://github.com/vitejs/vite) | `^5.0.0 \|\| ^6.0.0 \|\| ^7.0.0` |
| [`@vitejs/plugin-vue`](https://github.com/vitejs/vite-plugin-vue) | `^5.0.0` |

## Troubleshooting

### Stories not showing up in sidebar

Make sure your `main.ts` includes `*.stories.vue` in the stories glob:

```ts
stories: ['../src/**/*.stories.@(js|jsx|ts|tsx|vue)'],
```

### TypeScript errors with `defineMeta`

Make sure you're calling `defineMeta` inside `<script setup>` (not in regular `<script>`).

### Component not rendering with args

If using `asChild`, args are not passed to children. Use a template slot instead for dynamic stories.

## 🤝 Contributing

This project uses [pnpm](https://pnpm.io/installation) for dependency management.

1. Install dependencies with `pnpm install`
2. Start the development mode with `pnpm start`
3. Make your changes and add tests
4. Run tests with `pnpm test`

### Development Workflow

When making changes to the addon source code (`src/*`), you **MUST** follow this workflow:

1. **Build the addon** after any changes to `src/*`:
   ```bash
   pnpm build
   ```

2. **Restart Storybook** to pick up the new build:
   ```bash
   # Stop the current Storybook server (Ctrl+C)
   # Then restart it
   pnpm storybook
   ```

3. **Why this is necessary**: Storybook references the static `dist/` folder, and Vite's cache can cause stale builds. Simply saving files won't reflect changes automatically.

## Credits

This addon is inspired by and based on the work done in [`@storybook/addon-svelte-csf`](https://github.com/storybookjs/addon-svelte-csf). Thank you to the Storybook team and contributors for creating such a great foundation for framework-specific CSF addons.

## License

MIT

sb-addon-vue-csf

sb-addon-vue-csf Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

sb-addon-vue-csf

sb-addon-vue-csf Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README