Using next-yak with Storybook

The storybook-addon-yak addon enables next-yak in Storybook 10+. It supports both Vite and Webpack builders.

Installation

Install the addon alongside next-yak:

npm i -D storybook-addon-yak

pnpm i -D storybook-addon-yak

yarn add -D storybook-addon-yak

bun add -D storybook-addon-yak

Configuration (Vite)

Add the addon to your Storybook configuration:

.storybook/main.ts

import type { StorybookConfig } from "@storybook/react-vite";

const config: StorybookConfig = {
  stories: ["../src/**/*.stories.@(js|jsx|ts|tsx)"],
  addons: [
    "@storybook/addon-docs",
    "storybook-addon-yak",
  ],
  framework: {
    name: "@storybook/react-vite",
    options: {},
  },
};

export default config;

Configuration (Webpack)

Webpack requires the SWC compiler addon (@storybook/addon-webpack5-compiler-swc) for yak-swc plugin support.

.storybook/main.ts

import type { StorybookConfig } from "@storybook/react-webpack5";

const config: StorybookConfig = {
  stories: ["../src/**/*.stories.@(js|jsx|ts|tsx)"],
  addons: [
    "@storybook/addon-docs",
    "@storybook/addon-webpack5-compiler-swc",
    "storybook-addon-yak",
  ],
  framework: {
    name: "@storybook/react-webpack5",
    options: {},
  },
};

export default config;

Theme Context

If you use YakThemeProvider for theming, you can wrap your stories in the provider via the preview.tsx file:

.storybook/preview.tsx

import type { Preview } from "@storybook/react";
import { YakThemeProvider } from "next-yak";
import { getYakThemeContext } from "next-yak/context/baseContext";

const preview: Preview = {
  decorators: [
    (Story) => (
      <YakThemeProvider theme={getYakThemeContext()}>
        <Story />
      </YakThemeProvider>
    ),
  ],
};

export default preview;

Make sure your yak.context.ts file is configured via the addon options if it's not in the default location:

.storybook/main.ts

const config: StorybookConfig = {
  addons: [
    {
      name: "storybook-addon-yak",
      options: {
        contextPath: "./src/yak.context.ts",
      },
    },
  ],
  // ...
};

Example Project

You can find a full Storybook example in the repository with both Vite and Webpack configurations:

Storybook example: https://github.com/DigitecGalaxus/next-yak/tree/main/examples/storybook

Storybook

Using next-yak with Storybook

Installation

Configuration (Vite)

Configuration (Webpack)

Theme Context

Example Project

On this page