vite-plugin-storybook-nextjs weekly downloads statistics

vite-plugin-storybook-nextjs

This is a Vite plugin that allows you to use Next.js features in Vite. It is the basis for @storybook/nextjs-vite and should be used when running portable stories in Vitest.

Features

• Next.js Integration: Seamlessly integrate Next.js features into your Vite project. • Storybook Compatibility: Acts as the foundation for the @storybook/nextjs-vite framework, 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.

Requirements

• Next.js v14.1.0 or higher • Storybook 10 or higher

Installation

Install the plugin using your preferred package manager:

Usage

Set up Vitest

To 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

Add the plugin to your Vitest configuration file. This ensures that Vitest is aware of the Next.js features provided by the plugin.

If you are using @storybook/nextjs-vite you don't have to install vite-plugin-storybook-nextjs, since @storybook/nextjs-vite already re-exports it.

Configuration Options

You can configure the plugin using the following options:

FAQ: Including/Excluding images

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).

1. When using Storybook

2. When not using Storybook

Notes: • If you do not customize image.include, the plugin defaults to common image extensions. • Excluding **/*.svg?react prevents collisions so that import Icon from "./icon.svg?react" is compiled by SVGR, while import iconUrl from "./icon.svg" is handled by Next Image.

Usage with portable stories

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.

Automatic story transformation

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.

Limitations and differences to the Webpack5-based integration of Next.js in Storybook

next/font staticDir mapping obsolete

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.

CSS/SASS

The sassOptions property in next.config.js is not supported. Please use Vite's configuration options to configure the Sass compiler:

Next.js: Server Actions

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:

1. To apply it to individual story files, add a special comment at the top of each file:

2. To apply it to all tests, adjust your Vitest configuration:

SWC Mode

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).

License

This project is licensed under the MIT License.

Description from the npm listing.