@nx/next:component

Create a React Component for Next.

Examples

nx g component my-cmp --project=my-app

Usage

nx generate component ...

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

You can specify the collection explicitly as follows:

nx g @nx/next:component ...
Nx 15 and lower use @nrwl/ instead of @nx/

Show what will be generated without writing to disk:

nx g component ... --dry-run

Options

name

Required
string

The name of the component.

project

pRequired
string

The name of the project.

directory

dir
string

Create the component under this directory (can be nested).

export

e
boolean
Default: false

When true, the component is exported from the project index.ts (if it exists).

flat

boolean
Default: false

Create component at the source root rather than its own directory.

js

boolean
Default: false

Generate JavaScript files rather than TypeScript files.

pascalCaseFiles

P
boolean
Default: false

Use pascal case component file name (e.g. App.tsx).

pascalCaseDirectory

R
boolean
Default: false

Use pascal case directory name (e.g. App/App.tsx).

style

s
string
Default: css

The file extension to be used for style files.

skipTests

boolean
Default: false

When true, does not create spec.ts test files for the new component.

skipFormat

boolean
Default: false

Skip formatting files.