Back to integrations
Add your integration
Categories
  • ⭐️ Popular
  • 🧩 Essentials
  • 🛠 Code
  • ⚡️ Data & state
  • ✅ Test
  • 💅 Style
  • 🎨 Design
  • ⚙️ Appearance
  • 🗄 Organize
How to install addons Create an addon

Integrate Vuetify and Storybook

Vuetify is a Vue-based component library designed with Google's Material Design spec. This recipe shows you how to get the most out of Vuetify in Storybook.

Prerequisites

This recipe assumes that you have a Vue 3 app using Vuetify v3 and have just set up Storybook 7.0 using the getting started guide. Don’t have this? Follow Vuetify’s installation instructions then run:

Terminal
Loading...

1. Register Vuetify in Storybook

To get started, you'll need to add Vuetify’s fontloader and plugin to your Storybook configuration. To do this, add the following to your .storybook/preview.js file:

.storybook/preview.js
Loading...

Here registerPlugins loads Vuetify’s fonts and registers all of its components with Storybook’s Vue app.

2. Create a story wrapper component

Next, you will need to wrap your stories in Vuetify's v-app component in order to use some of its larger layout components like v-app-bar.

To do this, create a component in .storybook/ called StoryWrapper.vue

.storybook/StoryWrapper.vue
Loading...

3. Create a withVuetifyTheme decorator

Now create a storybook decorator to wrap your stories in your StoryWrapper component.

Below I created a new file in .storybook called withVuetifyTheme.decorator.js.

.storybook/withVeutifyTheme.decorator.js
Loading...

Now, give this decorator to Storybook in your preview.js file.

.storybook/preview.js
Loading...

4. Add a theme switcher tool

Vuetify comes out of the box with a light and dark theme that you can override or add to. To get the most out of your stories, you should have a way to toggle between all of your themes.

To add our switcher, declare a global type named theme in .storybook/preview.js and give it a list of supported themes to choose from.

.storybook/preview.js
Loading...

This code will create a new toolbar menu to select your desired theme for your stories.

5. Add a theme provider

There needs to be a way to tell Vuetify to use the theme selected in the toolbar. This can be done by updating our StoryWrapper component and withVuetifyTheme decorator

Firstly, give StoryWrapper a themeName prop that it can give to v-app

Loading...

Now pass our global theme variable to our StoryWrapper component as a prop with our decorator

.storybook/withVeutifyTheme.decorator.js
Loading...

Get involved

Now you're ready to use Vuetify with Storybook. 🎉 Check out the example repo for a quick start.

If you use Vuetify at work, we'd love your help making an addon that automatically applies the configuration above. Join the maintainers in Discord to get involved, or jump into addon docs.

Join the community
6,622 developers and counting
WhyWhy StorybookComponent-driven UI
DocsGuidesTutorialsChangelogTelemetry
CommunityAddonsGet involvedBlog
ShowcaseExploreProjectsComponent glossary
Open source software
Storybook

Maintained by
Chromatic
Special thanks to Netlify and CircleCI