3.0 KiB
| title | description |
|---|---|
| Storybook configuration generator examples | This page contains examples for the @nx/storybook:configuration generator. |
This is a framework-agnostic generator for setting up Storybook configuration for a project.
nx g @nx/storybook:configuration
{% callout type="info" title="Nx uses Storybook 7" %} Nx does not support Storybook v6 any more. So, Nx will configure your project to use Storybook v7. If you are not on Storybook 7 yet, please migrate. Please follow our Storybook 7 migration generator guide. {% /callout %}
If you are using Angular, React, Next.js, Vue or React Native in your project, it's best to use the framework specific Storybook configuration generator:
-
React Storybook Configuration Generator (React and Next.js projects)
If you are not using one of the framework-specific generators mentioned above, when running this generator you will be prompted to provide the following:
- The
nameof the project you want to generate the configuration for. - The
uiFrameworkyou want to use. Supported values are:@storybook/angular@storybook/html-webpack5@storybook/nextjs@storybook/preact-webpack5@storybook/react-webpack5@storybook/react-vite@storybook/server-webpack5@storybook/svelte-webpack5@storybook/svelte-vite@storybook/sveltekit@storybook/vue-webpack5@storybook/vue-vite@storybook/vue3-webpack5@storybook/vue3-vite@storybook/web-components-webpack5@storybook/web-components-vite
- Whether you want to set up Storybook interaction tests (
interactionTests). If you chooseyes, all the necessary dependencies will be installed. Also, atest-storybooktarget will be generated in your project'sproject.json, with a command to invoke the Storybooktest-runner. You can read more about this in the Nx Storybook interaction tests documentation page.
You must provide a name and a uiFramework for the generator to work.
You can read more about how this generator works, in the Storybook package overview page.
Examples
Generate Storybook configuration using JavaScript
nx g @nx/storybook:configuration ui --uiFramework=@storybook/web-components-vite --tsConfiguration=false
By default, our generator generates TypeScript Storybook configuration files. You can choose to use JavaScript for the Storybook configuration files of your project (the files inside the .storybook directory, eg. .storybook/main.js).