This is a Vite plugin that allows you to use Next.js features in Vite. It is the basis for @storybook/experimental-nextjs-vite and should be used when running portable stories in Vitest.
- Next.js Integration: Seamlessly integrate Next.js features into your Vite project.
- Storybook Compatibility: Acts as the foundation for the
@storybook/experimental-nextjs-viteframework, enabling you to use Storybook with Next.js in a Vite environment. - Portable Stories: Ideal for running portable stories in Vitest, ensuring your components are tested in an environment that closely mirrors production.
- Next.js v14.1.0 or higher
- Storybook 9 or higher
Install the plugin using your preferred package manager:
npm install vite-plugin-storybook-nextjs
# or
yarn add vite-plugin-storybook-nextjs
# or
pnpm add vite-plugin-storybook-nextjsTo use the plugin, you need to set up Vitest in your project. You can do this by following the instructions in the Vitest documentation.
Add the plugin to your Vitest configuration file. This ensures that Vitest is aware of the Next.js features provided by the plugin.
// vitest.config.ts
import { defineConfig } from "vite";
import nextjs from "vite-plugin-storybook-nextjs";
export default defineConfig({
plugins: [nextjs()],
});If you are using @storybook/experimental-nextjs-vite you don't have to install vite-plugin-storybook-nextjs, since @storybook/experimental-nextjs-vite already re-exports it.
// vitest.config.ts
import { defineConfig } from "vite";
import { storybookNextJsPlugin } from "@storybook/experimental-nextjs-vite/vite-plugin";
export default defineConfig({
plugins: [storybookNextJsPlugin()],
});You can configure the plugin using the following options:
type FilterPattern = ReadonlyArray<string | RegExp> | string | RegExp | null
type VitePluginOptions = {
/**
* Provide the path to your Next.js project directory
* @default process.cwd()
*/
dir?: string
/**
* Control which image files are handled by the Next Image plugin
* (Rollup-style include/exclude patterns)
*/
image?: {
include?: FilterPattern
exclude?: FilterPattern
}
}When you also use the SVG-to-React plugin vite-plugin-svgr, you may want SVGs imported with the ?react query to be handled by SVGR, while all other images (including plain SVGs) are handled by this plugin's Next Image processing. By default, the plugin already handles the **/*.svg?react case. But if you have custom configuration, you must configure the filters yourself.
You can achieve this by adding include/exclude patterns as plugin options. The patterns follow Rollup's FilterPattern semantics (micromatch).
// .storybook/main.ts
export default {
framework: {
name: '@storybook/nextjs-vite',
options: {
image: {
// Default image glob patterns are already applied; this is optional
// include: ['**/*.{png,jpg,jpeg,gif,webp,avif,ico,bmp,svg}'],
// Ensure SVGR takes precedence for React components from SVGs
exclude: ['**/*.svg?icon'],
},
}
}
}// vite.config.ts or vitest.config.ts
import { defineConfig } from 'vite'
import nextjs from 'vite-plugin-storybook-nextjs'
import svgr from 'vite-plugin-svgr'
export default defineConfig({
plugins: [
svgr({ include: '**/*.svg?react' }),
nextjs({
image: {
// Default image glob patterns are already applied; this is optional
// include: ['**/*.{png,jpg,jpeg,gif,webp,avif,ico,bmp,svg}'],
// Ensure SVGR takes precedence for React components from SVGs
exclude: ['**/*.svg?react'],
},
}),
],
})Notes:
- If you do not customize
image.include, the plugin defaults to common image extensions. - Excluding
**/*.svg?reactprevents collisions so thatimport Icon from "./icon.svg?react"is compiled by SVGR, whileimport iconUrl from "./icon.svg"is handled by Next Image.
Portable stories are Storybook stories which can be used in external environments, such as Vitest.
This plugin is necessary to run portable stories in Vitest, as it provides the necessary Next.js features to ensure that your components are tested in an environment that closely mirrors production.
The addon @storybook/addon-vitest can be used to automatically transform your stories at Vitest runtime to in-memory test files. This allows you to run your stories in a Vitest environment without needing to manually transform your stories. Please visit https://storybook.js.org/docs/8.3/writing-tests/test-runner-with-vitest for more information.
You don't need to map your custom font directory in Storybook's staticDir configuration. Instead, Vite will automatically serve the files in the public directory and provide assets during production builds.
The sassOptions property in next.config.js is not supported. Please use Vite's configuration options to configure the Sass compiler:
css: {
preprocessorOptions: {
scss: {
quietDeps: true
},
}
},When testing components that rely on Next.js Server Actions, you need to ensure that your story files are set up to use the jsdom environment in Vitest. This can be done in two ways:
-
To apply it to individual story files, add a special comment at the top of each file:
// @vitest-environment jsdom -
To apply it to all tests, adjust your Vitest configuration:
// vitest.config.ts import { defineConfig } from "vitest/config"; import nextjs from "vite-plugin-storybook-nextjs"; export default defineConfig({ plugins: [nextjs()], test: { environment: "jsdom", // 👈 Add this }, });
Only Next.js in SWC mode is supported. If your project was forced to opt out of Babel for some reason, you will very likely encounter issues with this plugin (e.g., Emotion support in SWC is still lagging behind).
This project is licensed under the MIT License.