executors

@nrwl/storybook:storybook

Serve up storybook in development mode.

Options can be configured in project.json when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.

Options playground

This is an example of what the properties looks like and their values. Go ahead and try, test your configuration this is a live-edit window, you can interact directly and get intellisense on property's values.

Loading...

Options

config

Required
config

.storybook configuration

docsMode

boolean
Default: false

Build a documentation-only site using addon-docs.

host

string
Default: localhost

Host to listen on.

https

boolean
Default: false

Serve using HTTPS.

port

number
Default: 9009

Port to listen on.

projectBuildConfig

string

Workspace project where Storybook reads the Webpack config from

quiet

boolean
Default: true

Suppress verbose build output.

sslKey

string

SSL key to use for serving HTTPS.

sslCert

string

SSL certificate to use for serving HTTPS.

staticDir

Deprecated
Array<string>

Directory where to load static files from, array of strings

In Storybook 6.4 the --static-dir CLI flag has been replaced with the the staticDirs field in .storybook/main.js. It will be removed completely in Storybook 7.0.

styles

Array<oneOf [object , string]>

Global styles to be included in the build. This is for Angular projects only, as an option for the Storybook/Angular builder. It will be ignored in non-Angular projects.

stylePreprocessorOptions.includePaths

Array<string>

Options to pass to style preprocessors. The paths to include. Paths will be resolved to workspace root. This is for Angular projects only, as an option for the Storybook/Angular builder. It will be ignored in non-Angular projects.

uiFramework

RequiredHidden
string
Default: @storybook/angular
Accepted values: @storybook/angular, @storybook/react, @storybook/html, @storybook/web-components, @storybook/vue, @storybook/vue3, @storybook/svelte

Storybook framework npm package

watch

boolean
Default: true

Watches for changes and rebuilds application