nx/docs/react/api-react/generators/component-story.md
Craigory V Coppola a1ccc87a07
docs(misc): documentation headers should include collectionName for searchability (#6451)
Signed-off-by: AgentEnder <craigorycoppola@gmail.com>
2021-07-21 11:40:59 -04:00

665 B

@nrwl/react:component-story

Generate storybook story for a react component

Usage

nx generate component-story ...

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

You can specify the collection explicitly as follows:

nx g @nrwl/react:component-story ...

Show what will be generated without writing to disk:

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

Options

componentPath (required)

Type: string

Relative path to the component file from the library root

project (required)

Type: string

The project name where to add the components.