storybook/vue3-vite.md at 5b57fe21bd97f35183564cff857c4868e98abae3

mirror of https://github.com/storybookjs/storybook.git synced 2025-04-06 06:11:11 +08:00

Kyle Gach 44f737b1fb Merge pull request #26266 from storybookjs/framework-doc-vue3-webpack5

Docs: Add `vue3-webpack5` framework doc

2024-03-11 13:52:14 -06:00

9.3 KiB

Raw Blame History

title
Storybook for Vue & Vite

export const SUPPORTED_RENDERER = 'vue';

Storybook for Vue & Vite is a framework that makes it easy to develop and test UI components in isolation for Vue applications built with Vite. It includes:

🏎️ Pre-bundled for performance
🪄 Zero config
🧠 Comprehensive docgen
💫 and more!

Storybook for Vue & Vite is only supported in Vue projects.

Requirements

Vue ≥ 3
Vite ≥ 4.0
Storybook ≥ 8.0

Getting started

In a project without Storybook

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

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:

Automatic migration

When running the upgrade command above, you should get a prompt asking you to migrate to @storybook/vue3-vite, 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:

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

Extending the Vue application

Storybook creates a Vue 3 application for your component preview. When using global custom components (app.component), directives (app.directive), extensions (app.use), or other application methods, you will need to configure those in the ./storybook/preview.js file.

Therefore, Storybook provides you with a setup function exported from this package, which receives as a callback your Storybook instance, which you can interact with and add your custom configuration.

// .storybook/preview.js
import { setup } from '@storybook/vue3';

setup((app) => {
  app.use(MyPlugin);
  app.component('my-component', MyComponent);
  app.mixin({
    /* My mixin */
  });
});

// Rest of the file...

Using `vue-component-meta`

vue-component-meta is only available in Storybook ≥ 8. It is currently opt-in, but will become the default in a future version of Storybook.

vue-component-meta is a tool maintained by the Vue team that extracts metadata from Vue components. Storybook can use it to generate the controls for your stories and documentation. It's a more full-featured alternative to vue-docgen-api and is recommended for most projects.

If you want to use vue-component-meta, you can configure it in your .storybook/main.js|ts file:

// .storybook/main.ts
import type { StorybookConfig } from '@storybook/vue3-vite';

const config: StorybookConfig = {
  framework: {
    name: '@storybook/vue3-vite',
    options: {
      docgen: 'vue-component-meta',
    },
  },
};

export default config;

vue-component-meta comes with many benefits and enables more documentation features, such as:

Support for multiple component types

vue-component-meta supports all types of Vue components (including SFC, functional, composition / options API components) from .vue, .ts, .tsx, .js, and .jsx files.

It also supports both default and named component exports.

Prop description and JSDoc tag annotations

To provide a description for a prop, including tags, you can use JSDoc comments in your component's props definition:

<!-- YourComponent.vue -->
<script setup lang="ts">
  interface MyComponentProps {
    /** The name of the user */
    name: string;
    /**
     * The category of the component
     *
     * @since 8.0.0
     */
    category?: string;
  }

  withDefaults(defineProps<MyComponentProps>(), {
    category: 'Uncategorized',
  });
</script>

The props definition above will generate the following controls:

Events types extraction

To provide a type for an emitted event, you can use TypeScript types (including JSDoc comments) in your component's defineEmits call:

<!-- YourComponent.vue -->
<script setup lang="ts">
  type MyChangeEvent = 'change';

  interface MyEvents {
    /** Fired when item is changed */
    (event: MyChangeEvent, item?: Item): void;
    /** Fired when item is deleted */
    (event: 'delete', id: string): void;
    /** Fired when item is upserted into list */
    (e: 'upsert', id: string): void;
  }

  const emit = defineEmits<MyEvents>();
</script>

Which will generate the following controls:

Slots types extraction

The slot types are automatically extracted from your component definition and displayed in the controls panel.

<!-- YourComponent.vue -->
<template>
  <slot :num="123"></slot>
  <br />
  <slot name="named" str="str"></slot>
  <br />
  <slot name="no-bind"></slot>
  <br />
  <slot name="vbind" v-bind="{ num: 123, str: 'str' }"></slot>
</template>

<script setup lang="ts"></script>

If you use defineSlots, you can provide a description for each slot using JSDoc comments in your component's slots definition:

defineSlots<{
  /** Example description for default */
  default(props: { num: number }): any;
  /** Example description for named */
  named(props: { str: string }): any;
  /** Example description for no-bind */
  noBind(props: {}): any;
  /** Example description for vbind */
  vbind(props: { num: number; str: string }): any;
}>();

The definition above will generate the following controls:

Exposed properties and methods

The properties and methods exposed by your component are automatically extracted and displayed in the controls panel.

<!-- YourComponent.vue -->
<script setup lang="ts">
  import { ref } from 'vue';

  const label = ref('Button');
  const count = ref(100);

  defineExpose({
    /** A label string */
    label,
    /** A count number */
    count,
  });
</script>

The definition above will generate the following controls:

Limitations

vue-component-meta cannot currently reference types from an import alias. You will need to replace any aliased imports with relative ones, as in the example below. See this issue for more information.

// YourComponent.ts
import type { MyProps } from '@/types'; // ❌ Cannot be resolved
import type { MyProps } from '../types'; // ✅ Can be resolved

Troubleshooting

Storybook doesn't work with my Vue 2 project

Vue 2 entered End of Life (EOL) on December 31st, 2023, and is no longer maintained by the Vue team. As a result, Storybook no longer supports Vue 2. We recommend you upgrade your project to Vue 3, which Storybook fully supports. If that's not an option, you can still use Storybook with Vue 2 by installing the latest version of Storybook 7 with the following command:

API

Options

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

// .storybook/main.ts
import type { StorybookConfig } from '@storybook/vue3-vite';

const config: StorybookConfig = {
  framework: {
    name: '@storybook/vue3-vite',
    options: {
      docgen: 'vue-component-meta',
    },
  },
};

export default config;

`builder`

Type: Record<string, any>

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

`docgen`

Type: 'vue-docgen-api' | 'vue-component-meta'

Default: 'vue-docgen-api'

Since: 8.0

Choose which docgen tool to use when generating controls for your components. See Using vue-component-meta for more information.

9.3 KiB Raw Blame History Unescape Escape