58 lines
2.7 KiB
Markdown
58 lines
2.7 KiB
Markdown
---
|
|
title: Storybook configuration generator examples
|
|
description: This page contains examples for the @nx/storybook:configuration generator.
|
|
---
|
|
|
|
This is a framework-agnostic generator for setting up Storybook configuration for a project.
|
|
|
|
```bash
|
|
nx g @nx/storybook:configuration
|
|
```
|
|
|
|
Starting Nx 16, 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. You can read more about how to migrate to Storybook 7 in our [Storybook 7 migration generator](/packages/storybook/generators/migrate-7) guide.
|
|
|
|
When running this generator, you will be prompted to provide the following:
|
|
|
|
- The `name` of the project you want to generate the configuration for.
|
|
- The `uiFramework` you 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 `configureCypress`. If you choose `yes`, a Cypress e2e app will be created (or configured) to run against the project's Storybook instance.
|
|
- Whether you want to `configureTestRunner`. If you choose `yes`, a `test-storybook` target will be generated in your project's `project.json`, with a command to invoke the [Storybook `test-runner`](https://storybook.js.org/docs/react/writing-tests/test-runner).
|
|
|
|
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](/packages/storybook#generating-storybook-configuration).
|
|
|
|
If you are using Angular, React, React Native or Next.js in your project, it's best to use the framework specific generator:
|
|
|
|
- [React Storybook Configuration Generator](/packages/react/generators/storybook-configuration) (React and Next.js projects)
|
|
|
|
- [Angular Storybook Configuration Generator](/packages/angular/generators/storybook-configuration)
|
|
|
|
- [React Native Storybook Configuration Generator](/packages/react-native/generators/storybook-configuration)
|
|
|
|
## Examples
|
|
|
|
### Generate Storybook configuration using TypeScript
|
|
|
|
```bash
|
|
nx g @nx/storybook:configuration ui --uiFramework=@storybook/web-components-vite --tsConfiguration=true
|
|
```
|
|
|
|
This will generate a Storybook configuration for the `ui` project using TypeScript for the Storybook configuration files (the files inside the `.storybook` directory).
|