@storybook/addon-vitest/dist/vitest-plugin/index.d.ts

Storybook addon for testing components

import { Plugin } from 'vitest/config';

type UserOptions = {
    /**
     * The directory where the Storybook configuration is located, relative to the vitest
     * configuration file. If not provided, the plugin will use '.storybook' in the current working
     * directory.
     *
     * @default '.storybook'
     */
    configDir?: string;
    /**
     * Optional script to run Storybook. If provided, Vitest will start Storybook using this script
     * when ran in watch mode.
     *
     * @default undefined
     */
    storybookScript?: string;
    /**
     * The URL where Storybook is hosted. This is used to provide a link to the story in the test
     * output on failures.
     *
     * @default 'http://localhost:6006'
     */
    storybookUrl?: string;
    /** Tags to include, exclude, or skip. These tags are defined as annotations in your story or meta. */
    tags?: {
        include?: string[];
        exclude?: string[];
        skip?: string[];
    };
    /**
     * Whether to disable addon docs features while running tests.
     *
     * Most users don't need addon docs for tests, the only scenario where you might need it is if you
     * need to read and parse MDX files as part of rendering your components.
     *
     * @default true
     */
    disableAddonDocs?: boolean;
};

declare const storybookTest: (options?: UserOptions) => Promise<Plugin[]>;

export { storybookTest as default, storybookTest };