Toggle between light and dark mode in Storybook

Downloads per week

@storybook-community/storybook-dark-mode

A storybook addon that lets your users toggle between dark and light mode.

[!NOTE] This is a fork of storybook-dark-mode by @hipstersmoothie to support Storybook 9 and newer.

Example

Installation

npm i --save-dev @storybook-community/storybook-dark-mode

yarn add -D @storybook-community/storybook-dark-mode

pnpm add -D @storybook-community/storybook-dark-mode

Configuration

Add following content to .storybook/main.ts

// .storybook/main.ts
export default {
  addons: ['@storybook-community/storybook-dark-mode']
};

Configure the dark and light mode by adding the following to your .storybook/preview.ts file:

CSF 3

// .storybook/preview.ts
import { themes } from 'storybook/theming';

export const parameters = {
  darkMode: {
    // Override the default dark theme
    dark: { ...themes.dark, appBg: 'black' },
    // Override the default light theme
    light: { ...themes.normal, appBg: 'red' }
  }
};

CSF Next

// .storybook/preview.ts
import { definePreview } from '@storybook/your-framework'
import addonDarkMode from '@storybook-community/storybook-dark-mode'
import addonDocs from '@storybook/addon-docs'

export default definePreview({
  // Load addon annotations
  addons: [addonDocs(), addonDarkMode()],
  parameters: {
    darkMode: {
      // Override the default dark theme
      dark: { ...themes.dark, appBg: 'black' },
      // Override the default light theme
      light: { ...themes.normal, appBg: 'red' }
    }
  }
})

Default Theme

Order of precedence for the initial color scheme:

If the user has previously set a color theme it's used
The value you have configured for current parameter in your storybook
The OS color scheme preference

Once the initial color scheme has been set, subsequent reloads will use this value. To clear the cached color scheme you have to localStorage.clear() in the chrome console.

// .storybook/preview.ts
export const parameters = {
  darkMode: {
    // Set the initial theme
    current: 'light'
  }
}

Dark/Light Class

This plugin will apply a dark and light class name to the manager. This allows you to easily write dark mode aware theme overrides for the storybook UI.

You can override the classNames applied when switching between light and dark mode using the darkClass and lightClass parameters.

export const parameters = {
  darkMode: {
    darkClass: 'lights-out',
    lightClass: 'lights-on'
  }
};

You can also pass an array to apply multiple classes.

export const parameters = {
  darkMode: {
    darkClass: ['lights-out', 'foo'],
    lightClass: ['lights-on', 'bar']
  }
};

Preview class target

This plugin will apply the dark/light class to the <body> element of the preview iframe. This can be configured with the classTarget parameter. The value will be passed to a querySelector() inside the iframe.

This is useful if the <body> is styled according to a parent's class, in that case it can be set to html.

export const parameters = {
  darkMode: {
    classTarget: 'html'
  }
};

Preview `ClassName`

This plugin will apply the darkClass and lightClass classes to the preview iframe if you turn on the stylePreview option.

export const parameters = {
  darkMode: {
    stylePreview: true
  }
};

Support for Docs mode

// .storybook/preview.ts
export const parameters = {
  docs: {
    container: DarkModeDocsContainer
  }
}

React

If your components use a custom Theme provider, you can integrate it by using the provided hook.

import { useDarkMode } from '@storybook-community/storybook-dark-mode'
import { addDecorator } from 'storybook/react-vite'

// your theme provider
import ThemeContext from './theme'

// create a component that uses the dark mode hook
function ThemeWrapper(props) {
  // render your custom theme provider
  return (
    <ThemeContext.Provider value={useDarkMode() ? darkTheme : defaultTheme}>
      {props.children}
    </ThemeContext.Provider>
  );
}

export const decorators = [renderStory => <ThemeWrapper>{renderStory()}</ThemeWrapper>)];

Theme Knobs

If you want to have your UI's dark mode separate from your components' dark mode, implement this global decorator:

import { createElement } from 'react'
import { themes } from 'storybook/theming'

// Add a global decorator that will render a dark background when the
// "Color Scheme" knob is set to dark
const knobDecorator = storyFn => {
  // A knob for color scheme added to every story
  const colorScheme = select('Color Scheme', ['light', 'dark'], 'light')

  // Hook your theme provider with some knobs
  return createElement(ThemeProvider, {
    // A knob for theme added to every story
    theme: select('Theme', Object.keys(themes), 'default'),
    colorScheme,
    children: [
      createElement('style', {
        dangerouslySetInnerHTML: {
          __html: `html { ${
            colorScheme === 'dark' ? 'background-color: rgb(35,35,35);' : ''
          } }`
        }
      }),
      storyFn()
    ]
  });
};

export const decorators = [knobDecorator]

Events

You can also listen for the DARK_MODE event via the addons channel.

import { addDecorator } from '@storybook/react-vite'
import { DARK_MODE_EVENT_NAME } from '@storybook-community/storybook-dark-mode'
import { addons } from 'storybook/preview-api'

// your theme provider
import ThemeContext from './theme'

// get channel to listen to event emitter
const channel = addons.getChannel()

// create a component that listens for the DARK_MODE event
function ThemeWrapper(props) {
  // this example uses hook but you can also use class component as well
  const [isDark, setDark] = useState(false)

  useEffect(() => {
    // listen to DARK_MODE event
    channel.on(DARK_MODE_EVENT_NAME, setDark)
    return () => channel.off(DARK_MODE_EVENT_NAME, setDark)
  }, [channel, setDark])

  // render your custom theme provider
  return (
    <ThemeContext.Provider value={isDark ? darkTheme : defaultTheme}>
      {props.children}
    </ThemeContext.Provider>
  )
}

export const decorators = [renderStory => <ThemeWrapper>{renderStory()}</ThemeWrapper>)]

Made by

unional