@nx/react:component
Create a React Component for Nx.
Examples
Create a component named my-component under the libs/ui project:
❯
nx g @nx/react:component libs/ui/src/my-component
Usage
1nx generate component ...
21nx g c ... #same
2By default, Nx will search for component in the default collection provisioned in workspace.json.
You can specify the collection explicitly as follows:
1nx g @nx/react:component ...
2Show what will be generated without writing to disk:
1nx g component ... --dry-run
2Options
path
Required
string
The file path to the component without the file extension (e.g. my-app/src/app/my-component/my-component generates the file my-app/src/app/my-component/my-component.tsx). Relative to the current working directory.
classComponent
C
boolean
Default:
falseUse class components instead of functional component.
export
e
boolean
Default:
falseWhen true, the component is exported from the project index.ts (if it exists).
fileName
string
Create a component with this file name.
globalCss
boolean
Default:
falseDefault is false. When true, the component is generated with *.css/*.scss instead of *.module.css/*.module.scss.
inSourceTests
boolean
Default:
falseWhen using Vitest, separate spec files will not be generated and instead will be included within the source files. Read more on the Vitest docs site: https://vitest.dev/guide/in-source.html
js
boolean
Default:
falseGenerate JavaScript files rather than TypeScript files.
name
string
The component symbol name. Defaults to the last segment of the file path.
routing
boolean
Generate a library with routes.
style
s
string
Default:
cssThe file extension to be used for style files.
skipTests
Internal
boolean
Default:
falseWhen true, does not create spec.ts test files for the new component.
skipFormat
Internal
boolean
Default:
falseSkip formatting files.