Schema for internal use only

Please do not extend this schema as it is part of Nx internal usage.

@nx/angular:component-story

Creates a stories.ts file for an Angular component.

Usage

1nx generate component-story ... 2

By default, Nx will search for component-story in the default collection provisioned in workspace.json.

You can specify the collection explicitly as follows:

1nx g @nx/angular:component-story ... 2
Nx 15 and lower use @nrwl/ instead of @nx/

Show what will be generated without writing to disk:

1nx g component-story ... --dry-run 2

Options

componentName

Required
string

Class name of the component.

componentPath

Required
string

Relative path to the component file from the project root.

componentFileName

Required
string

Component file name without the .ts extension.

projectPath

Required
string

Path to the project.

interactionTests

boolean
Default: true

Set up Storybook interaction tests.

skipFormat

Internal
boolean
Default: false

Skip formatting files.