storybook-vue3-router

Storybook Vue 3 Router

A Storybook decorator that allows you to use your routing-aware components.

You will need to use this plugin if you wish to include stories for any component using Vue Router v4 <router-view> and <router-link>

Vue Router v4 is used with Vue 3 projects.

Install

npm install storybook-vue3-router

Quick Usage

After installing you can import the Storybook decorator and start working with components using Vue Router v4

/* import Storybook addon (decorator for Vue Router) */
import vueRouter from 'storybook-vue3-router'

/* ...story setup... */

/* your story export */
export const Default = Template.bind({})

/* adding custom decorator to allow use of `<router-view>` and Vue Router 4+ */
Default.decorators = [
  vueRouter()
]

Full Example

/* import `action` to log router changes (this can be used by this addon to log router events) */
import { action } from '@storybook/addon-actions';

/* import Storybook addon (decorator for Vue Router) */
import vueRouter from 'storybook-vue3-router'

/* component you're writing story for */
import myRouterWrapperComponent from './myRouterWrapperComponent.vue'

/* your component defaults */
export default {
  title: 'Components/Vue Router View Wrapper',
  component: myRouterWrapperComponent,
}

/* your component story */
const Template = (args: Record<string, unknown>) => ({
  components: { 'MyRouterWrapper': myRouterWrapperComponent },
  setup () {
    return { args }
  },
  template: `<MyRouterWrapper />`
})
/* your story export */
export const Default = Template.bind({})

/* adding custom decorator to allow use of `<router-view>` and Vue Router 4+ */
Default.decorators = [
  vueRouter(null, (to, from) => action('ROUTE CHANGED')({ to: to, from: from }))
]

The example above uses:

Default.decorators = [
  vueRouter(null, (to, from) => action('ROUTE CHANGED')({ to: to, from: from }))
]

Which will:

• Use this packages default routes (/ and /about routes, with <router-link> for each route)
• Add a Storybook action to log the route changes

Custom routes

You can pass custom router setup by including (or importing into your .stories. file) and passing this as the first parametor within the vueRouter decorator:

const customRoutes = [
  {
    path: '/',
    name: 'home',
    component: HomeComponent // this would need to be imported into the `.stories` file
  },
  {
    path: '/about',
    name: 'about',
    component: AboutComponent // this would need to be imported into the `.stories` file
  }
  {
    /* ... other routes ... */
  }
]

/* ... other story setup ... */
Default.decorators = [
  vueRouter(customRoutes, (to, from) => action('ROUTE CHANGED')({ to: to, from: from }))
]

Optional Action

The second parameter for vueRouter is a function which is ran on Vue Routers beforeEach route guard.

In our examples we're using this to log an action event to the Storybook UI.

This parametor is optional.

Changelog

v1.0.4 (Fri Sep 10 2021)

🐛 Bug Fix

• Adding vue-router@4 as a dependancy #5 (@NickMcBurney)
• Enable viewmode = docs #3 (@gsedlacz)
• Resolving Incorrect Entry Point #2 (@NickMcBurney)

⚠️ Pushed to main

• v1.0.1 (@NickMcBurney)
• package description update (@NickMcBurney)
• readme update (@NickMcBurney)

Authors: 2

• Gerrit Sedlaczek (@gsedlacz)
• Nick McBurney (@NickMcBurney)