Modes for testing themes, viewports, locales & more

Global-level configurations (globals) such as viewport size, theme (light/dark), and locale impact how a component renders. Chromatic simplifies the process of visually testing your stories with different global configs.

You can save combinations of globals as a unique “mode” and apply one or multiple modes to a story using the chromatic.modes parameter. When Chromatic tests your story, it will capture a snapshot for each applied mode. These modes are treated separately, with independent baselines and distinct approvals.

Using modes requires Storybook 6.0 or later.

Using modes

A mode is a combination of different settings that determine the appearance of a UI. It can be as straightforward as displaying the component in light or dark mode, or it can involve more complex combinations like viewport, theme, and locale settings.

Example modes:

• dark desktop spanish
• light tablet korean
• mobile english
• high-contrast

1. Configure addons

Addons offer the ability to control various global settings within Storybook. For instance, you can use viewports, styling, and background addons to manage the theme, dimensions, and background color of a story.

Make sure to configure the addons in .storybook/preview.js for each global setting you want to test.

// .storybook/preview.js

import { withThemeByClassName } from "@storybook/addon-themes";
import "../src/index.css";

const preview = {
  parameters: {
    viewport: {
      viewports: {
        small: { name: "Small", styles: { width: "640px", height: "800px" } },
        large: { name: "Large", styles: { width: "1024px", height: "1000px" } },
      },
    },
    backgrounds: {
      values: [
        { name: "light", value: "#fff" },
        { name: "dark", value: "#1E293B" },
      ],
    },
  },
  decorators: [
    withThemeByClassName({
      themes: {
        light: "light",
        dark: "dark",
      },
      defaultTheme: "light",
    }),
  ],
};

export default preview;

2. Define modes

To define all your modes, create a file called .storybook/modes.js. Each mode should specify the values for the global settings it wants to control. This can be limited to a single global or can group multiple globals together.

// .storybook/modes.js

export const allModes = {
  mobile: {
    viewport: "small",
  },
  desktop: {
    viewport: "large",
  },
  dark: {
    backgrounds: { value: "#1E293B" },
    theme: "dark",
  },
  light: {
    backgrounds: { value: "#fff" },
    theme: "light",
  },
  "dark desktop": {
    backgrounds: { value: "#1E293B" },
    theme: "dark",
    viewport: "large",
  },
  "light mobile": {
    backgrounds: { value: "#fff" },
    theme: "light",
    viewport: "small",
  },
};

3. Apply modes using the chromatic parameter

To apply the modes to a component, import them into a CSF (*.stories.js) file and use the chromatic parameter.

// ArticleCard.stories.js

import { allModes } from "../.storybook/modes";
import { ArticleCard } from "./ArticleCard";

export default {
  component: ArticleCard,
  title: "ArticleCard",
  parameters: {
    chromatic: {
      //🔶 Test each story for ArticleCard in two modes
      modes: {
        "light mobile": allModes["light mobile"],
        "dark desktop": allModes["dark desktop"],
      },
    },
  },
};

export const Base = {
  args: {
    //...
  },
};
export const MembersOnly = {
  args: {
    //...
  },
};

4. Auto-generate a test for every mode

When you run a Chromatic build, it will create a test for each mode. If you have two stories with two modes, you’ll get four tests. Each test will be badged with the mode’s name and have separate baselines and approvals.

When reviewing a build, the mode-specific tests will be grouped together.

Stacking modes

You have the flexibility to apply modes at the project, component level, or the story level. Instead of overriding modes defined at a higher level, Chromatic combines them all into a stack and tests the story against each mode in the stack.

Project level modes

For instance, at the project level, we apply modes by setting the chromatic parameter in .storybook/preview.js:

// .storybook/preview.js

import { allModes } from "../.storybook/modes";

const preview = {
  parameters: {
    chromatic: {
      modes: {
        light: allModes["light"],
        dark: allModes["dark"],
      },
    },
  },
};

export default preview;

Component and Story level modes

Then in the CSF file we set modes at the component level and/or the story level:

// ArticleCard.stories.js

import { allModes } from "../.storybook/modes";
import { ArticleCard } from "./ArticleCard";

export default {
  component: ArticleCard,
  title: "ArticleCard",
  parameters: {
    chromatic: {
      //🔶 Test each story for ArticleCard with this mode
      modes: {
        desktop: allModes["desktop"],
      },
    },
  },
};

export const Base = {
  args: {
    //...
  },
  parameters: {
    chromatic: {
      //🔶 Test only the Base story with this mode
      modes: {
        mobile: allModes["mobile"],
      },
    },
  },
};

export const MembersOnly = {
  args: {
    //...
  },
};

In the example above (.storybook/preview.js combined with ArticleCard.stories.js), Chromatic will generate the following tests:

1. For ArticleCard.Base, there will be 4 snapshots: light, dark, desktop, and mobile.
2. For ArticleCard.MembersOnly, there will be 3 snapshots: light, dark, and desktop.

Disable a higher-level mode

In some situations, you might want to disable a mode defined at higher level for a specific story. You can do this by setting disable: true on the mode.

In the example below, desktop mode is applied at the component level. But we’re disabling it for the Base story.

// ArticleCard.stories.js

import { allModes } from "../.storybook/modes";
import { ArticleCard } from "./ArticleCard";

export default {
  component: ArticleCard,
  title: "ArticleCard",
  parameters: {
    chromatic: {
      modes: {
        desktop: allModes["desktop"],
      },
    },
  },
};

export const Base = {
  args: {
    //...
  },
  parameters: {
    chromatic: {
      //🔶 Disable desktop mode for the Base Story
      modes: {
        desktop: { disable: true },
      },
    },
  },
};
export const MembersOnly = {
  args: {
    //...
  },
};

Baselines for modes

Chromatic treats each mode as an individual entity, with its own unique baselines and specific approvals. The baselines for each mode are dependent solely on the name, rather than the type or value of globals defined within that mode.

Let’s look at an example, this Storybook uses the following set of modes:

// .storybook/modes.js

export const allModes = {
  "dark desktop": {
    backgrounds: { value: "#1E293B" },
    theme: "dark",
    viewport: "large",
  },
  "light mobile": {
    backgrounds: { value: "#fff" },
    theme: "light",
    viewport: "small",
  },
};

We then apply some of those modes to a component, like so:

// ArticleCard.stories.js

import { allModes } from "../.storybook/modes";
import { ArticleCard } from "./ArticleCard";

export default {
  component: ArticleCard,
  parameters: {
    chromatic: {
      //🔶 Test each story for ArticleCard in two modes
      modes: {
        "light mobile": allModes["light mobile"],
        "dark desktop": allModes["dark desktop"],
      },
    },
  },
};

export const Base = {
  args: {
    //...
  },
};
export const MembersOnly = {
  args: {
    //...
  },
};

With the above configuration, Chromatic will capture the following snapshots:

1. For ArticleCard.Base, 2 snapshots: light mobile and dark desktop
2. For ArticleCard.MembersOnly, 2 snapshots: light mobile and dark desktop

Now, let’s consider a scenario where we modify the definition of the mode. Even if the viewport size changes, Chromatic will continue to compare the new snapshot for dark desktop against the previously accepted baseline for dark desktop.

// .storybook/modes.js

export const allModes = {
  "dark desktop": {
    backgrounds: { value: "#1E293B" },
    theme: "dark",
    // Using a different viewport size now
    viewport: "extra-large",
  },
  "light mobile": {
    backgrounds: { value: "#fff" },
    theme: "light",
    viewport: "small",
  },
};

Maintain the original non-modes based baseline

Sometimes, you might want to keep the original baseline for a story while testing it with extra modes. Add a mode called 1200px with the value { viewport: 1200 } to your story. This way, you can maintain the original baseline and still test the story with additional modes.

Let’s take an example scenario. We want to test the base story in both light and dark modes. By introducing the 1200px mode, we can maintain the original baseline for that story while also testing it with light and dark modes.

// ArticleCard.stories.js

import { allModes } from "../.storybook/modes";
import { ArticleCard } from "./ArticleCard";

export default {
  component: ArticleCard,
  parameters: {
    chromatic: {
      //🔶 Test each story for ArticleCard in two modes
      modes: {
        "light mobile": allModes["light mobile"],
        "dark desktop": allModes["dark desktop"],
        "1200px": { viewport: 1200 },
      },
    },
  },
};

export const Base = {
  args: {
    //...
  },
};

Frequently asked questions