@storybook/vue3

What is @storybook/vue3?

@storybook/vue3 is a tool for developing UI components in isolation for Vue 3 applications. It allows developers to build, test, and document components in a standalone environment, which helps in creating robust and reusable components.

What are @storybook/vue3's main functionalities?

Component Development

Allows developers to create and showcase different states of Vue 3 components in isolation.

import { storiesOf } from '@storybook/vue3';
import MyButton from './MyButton.vue';

storiesOf('MyButton', module)
  .add('default', () => ({
    components: { MyButton },
    template: '<my-button>Default</my-button>',
  }))
  .add('primary', () => ({
    components: { MyButton },
    template: '<my-button primary>Primary</my-button>',
  }));

Interactive Documentation

Enables the creation of interactive documentation for components, allowing users to see how components behave with different props and states.

import { Meta, Story } from '@storybook/vue3';
import MyButton from './MyButton.vue';

export default {
  title: 'Example/MyButton',
  component: MyButton,
} as Meta;

const Template: Story = (args) => ({
  components: { MyButton },
  setup() {
    return { args };
  },
  template: '<my-button v-bind="args" />',
});

export const Primary = Template.bind({});
Primary.args = {
  primary: true,
  label: 'Button',
};

Add-ons Support

Supports various add-ons to enhance the development experience, such as knobs for dynamic prop editing.

import { withKnobs, text, boolean } from '@storybook/addon-knobs';
import MyButton from './MyButton.vue';

export default {
  title: 'MyButton',
  decorators: [withKnobs],
};

export const withKnobsExample = () => ({
  components: { MyButton },
  props: {
    label: {
      type: String,
      default: text('Label', 'Button'),
    },
    primary: {
      type: Boolean,
      default: boolean('Primary', false),
    },
  },
  template: '<my-button :primary="primary">{{ label }}</my-button>',
});

Other packages similar to @storybook/vue3

vue-styleguidist

Vue Styleguidist is a component development environment with a focus on documentation. It allows developers to create and maintain a living style guide for Vue components. Compared to @storybook/vue3, Vue Styleguidist is more focused on documentation and less on interactive component development.

docz

Docz is a documentation tool that supports multiple frameworks, including Vue. It allows developers to create interactive documentation for their components. While it provides similar documentation capabilities as @storybook/vue3, it is more general-purpose and not specifically tailored for Vue 3.

vue-play

Vue Play is a minimalistic library for developing and testing Vue components in isolation. It offers a simpler and more lightweight alternative to @storybook/vue3, but lacks some of the advanced features and add-ons that Storybook provides.

README

Storybook Vue3 renderer

Changelog

9.1.0

Storybook 9.1 is packed with new features and improvements to enhance accessibility, streamline testing, and make your development workflow even smoother!

🚀 Improved upgrade command with monorepo support for seamless upgrades 🅰 Angular fixes for Tailwind 4, cache busting, and zoneless compatibility 🧪 sb.mock API and Automocking: one-line module mocking to simplify your testing workflow 🧪 Favicon shows test run status for quick visual feedback ⚛️ Easier configuration for React Native projects 🔥 Auto-abort play functions on HMR to avoid unwanted side effects 🏗️ Improved CSF factories API for type safe story definitions ♿️ A11y improvements across Storybook’s UI — addon panel, toolbar, sidebar, mobile & more 💯 Dozens more fixes and improvements based on community feedback!

<details> <summary>List of all updates</summary>

• A11y: Improved toolbar a11y by fixing semantics - #28672, thanks @mehm8128!
• Addon Vitest: Remove Optimize deps candidates due to Vitest warnings - #31809, thanks @valentinpalkovic!
• Angular: Bundle using TSup - #31690, thanks @ndelangen!
• Angular: Prevent directory import in Angular builders - #32012, thanks @ghengeveld!
• Automigration: Await updateMainConfig in removeEssentials - #32140, thanks @valentinpalkovic!
• Builder-Vite: Fix logic related to setting allowedHosts when IP address used - #31472, thanks @JSMike!
• Controls: Improve the accessibility of the object control - #31581, thanks @Sidnioulz!
• Core: Abort play function on HMR - #31542, thanks @ghengeveld!
• Core: Avoid pausing animations in non-Vitest Playwright environments - #32123, thanks @ghengeveld!
• Core: Cleanup of type following up v9 and small verbatimModuleSyntax type fix - #31823, thanks @alcpereira!
• Core: Fix aria-controls attribute on sidebar nodes to include all children - #31491, thanks @candrepa1!
• Core: Fix horizontal scrollbar covering part of the toolbar - #31704, thanks @Sidnioulz!
• Core: Fix moving log file across drives and projectRoot detection on Windows - #32020, thanks @ghengeveld!
• Core: Prevent interactions panel from flickering and showing incorrect state - #32150, thanks @ghengeveld!
• Core: Serve dynamic favicon based on testing module status - #31763, thanks @ghengeveld!
• Core: Support container queries in addon panels - #23261, thanks @neil-morrison44!
• CSF Factories: Add parameters/globals types, extend API, portable stories - #30601, thanks @kasperpeulen!
• CSF: Improve controls parameters - #31745, thanks @kasperpeulen!
• CSF: Improve docs parameter types - #31736, thanks @kasperpeulen!
• CSF: Only add preview annotations to definePreview in csf-factories automigration - #31727, thanks @kasperpeulen!
• Docs: Update @storybook/icons - #32144, thanks @valentinpalkovic!
• Docs: Update react-element-to-jsx-string - #31170, thanks @7rulnik!
• Init: Exclude mdx stories when docs feature isn't selected during init - #32142, thanks @valentinpalkovic!
• Maintenance: Add flag to toggle default automigrations - #32113, thanks @yannbf!
• React Native Web: Simplify config by using vite-plugin-rnw - #32051, thanks @dannyhw!
• Telemetry: Add automigration errors - #32103, thanks @yannbf!
• Telemetry: Fix project.json for getAbsolutePath - #31510, thanks @ndelangen!
• Test: Add mock capabilities - #31987, thanks @valentinpalkovic!
• Test: Consider exports map - #32157, thanks @valentinpalkovic!
• Test: Fix missing source map for Webpack/Vite mock loaders and plugins - #32111, thanks @valentinpalkovic!
• Test: Invalidate vite cache for manual mocks - #32152, thanks @valentinpalkovic!
• Test: Remove source map generation from webpack automock-loader - #32115, thanks @valentinpalkovic!
• UI: Apply user updates for mobile navigation accessibility - #31401, thanks @yatishgoel!
• UI: Fix interaction step collapse icon - #31853, thanks @AvitalHass!
• UI: Visual focus indicators (VFIs) aren't visible in high contrast mode (rebase) - #31848, thanks @Sidnioulz!

</details>