@nrwl/storybook:configuration
Add Storybook configuration to a UI library or an application.
This is a framework-agnostic generator for setting up Storybook configuration for a project.
nx g @nrwl/storybook:configuration
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/react"
,"@storybook/react-native"
,"@storybook/html"
,"@storybook/web-components"
,"@storybook/vue"
,"@storybook/vue3"
and"@storybook/svelte"
. - Whether you want to
configureCypress
. If you chooseyes
, a Cypress e2e app will be created (or configured) to run against the project's Storybook instance. - Whether you want to
configureTestRunner
. If you chooseyes
, atest-storybook
target will be generated in your project'sproject.json
, with a command to invoke the Storybooktest-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.
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 (React and Next.js projects)
Examples
Generate Storybook configuration using TypeScript
nx g @nrwl/storybook:configuration ui --uiFramework=@storybook/web-components --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).
Generate Storybook configuration for Storybook version 7
nx g @nrwl/storybook:configuration ui --uiFramework=@storybook/react --storybook7betaConfiguration=true
OR
nx g @nrwl/storybook:configuration ui --storybook7UiFramework=@storybook/react-vite --storybook7betaConfiguration=true
This will generate a Storybook configuration for the ui
project using Storybook version 7. It will install the Storybook version 7 dependencies and configure the Storybook configuration files (the files inside the .storybook
directory) to use Storybook version 7.
Usage
nx generate configuration ...
By default, Nx will search for configuration
in the default collection provisioned in workspace.json.
You can specify the collection explicitly as follows:
nx g @nrwl/storybook:configuration ...
Show what will be generated without writing to disk:
nx g configuration ... --dry-run