Automatic visual tests in Storybook, plus 2.2x faster build times for React+TSVisual test with Chromatic
Back to integrations
Add your integration
  • ⭐️ Popular
  • 🧩 Essentials
  • 🛠 Code
  • ⚡️ Data & state
  • ✅ Test
  • 💅 Style
  • 🎨 Design
  • ⚙️ Appearance
  • 🗄 Organize
How to install addons Create an addon
Drupal Addon
Storybook addon to facilitate integrating Storybook with Drupal projects.
npm install @lullabot/storybook-drupal-addon
Last updated 9 days ago
Downloads per week
Readme View on GitHub

Drupal Storybook Addon

A library for best-practice Drupal integration addons in Storybook:

  • Easy-to-use Drupal integration
  • Simple drop-down menu
  • URL-linkable state for sharing


Configure your Drupal site

🌳 Install the Drupal module

Install and enable the Drupal module:

composer require drupal/cl_server;
drush pm:enable --yes cl_server;

🌴 Add Storybook to your Drupal repo

From the root of your repo:

yarn global add sb@latest;
sb init --builder webpack5 --type server
# If you have a reason to use Webpack4 use the following instead:
# sb init --type server
yarn add -D @lullabot/storybook-drupal-addon

🌵 Configure Storybook

First enable the addon. Add it to the addons in the .storybook/main.js.

// .storybook/main.js
module.exports = {
  // ...
  addons: [
    // ...
  // ...

Then, configure the supportedDrupalThemes and drupalTheme parameters in .storybook/preview.js.

supportedDrupalThemes is an object where the keys are the machine name of the Drupal themes and the values are the plain text name of that Drupal theme you want to use. This is what will appear in the dropdown in the toolbar.

// .storybook/preview.js
const preview: Preview = {
  // ...
  globals: {
    // ...
    drupalTheme: 'umami',
    supportedDrupalThemes: {
      umami: {title: 'Umami'},
      bartik: {title: 'Bartik'},
      claro: {title: 'Claro'},
      seven: {title: 'Seven'},
  parameters: {
    server: {
      // Replace this with your Drupal site URL, or an environment variable.
      url: '',
    // ...
  // ...

export default preview;

Start Storybook

Start the development server Storybook server:

yarn storybook

Storybook addon authors

As an addon author, you can use this library by adding it as a dependency and adding the following to your src/manager.ts and src/preview.ts files:


export * from '@lullabot/storybook-drupal-addon/manager';


import type { Renderer, ProjectAnnotations } from '@storybook/types';
import drupalPreview from '@lullabot/storybook-drupal-addon/preview';
import { withYourDrupalDecorator } from './withYourDecorator';

// @ts-ignore
const drupalDecorators = drupalPreview?.decorators || [];

const preview: ProjectAnnotations<Renderer> = {
    decorators: [...drupalDecorators, withYourI18nDecorator],

export default preview;

The currently selected drupal theme is available in the drupalTheme global, so you can access it in a decorator using the following snippet:

import { MyProvider } from 'your-drupal-library';
import { useGlobals } from '@storybook/manager-api';

const myDecorator = (story, context) => {
  const [{drupalTheme}] = useGlobals();
  return <MyProvider drupalTheme={drupalTheme}>;
Join the community
6,319 developers and counting
WhyWhy StorybookComponent-driven UI
Open source software

Maintained by
Special thanks to Netlify and CircleCI