108 lines
1.5 KiB
Markdown
108 lines
1.5 KiB
Markdown
# component
|
|
|
|
Create a component
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
nx generate component ...
|
|
```
|
|
|
|
By default, Nx will search for `component` in the default collection provisioned in `angular.json`.
|
|
|
|
You can specify the collection explicitly as follows:
|
|
|
|
```bash
|
|
nx g @nrwl/gatsby:component ...
|
|
```
|
|
|
|
Show what will be generated without writing to disk:
|
|
|
|
```bash
|
|
nx g component ... --dry-run
|
|
```
|
|
|
|
### Examples
|
|
|
|
Generate a component in the mylib library:
|
|
|
|
```bash
|
|
nx g component my-component --project=mylib
|
|
```
|
|
|
|
Generate a class component in the mylib library:
|
|
|
|
```bash
|
|
nx g component my-component --project=mylib --classComponent
|
|
```
|
|
|
|
## Options
|
|
|
|
### directory
|
|
|
|
Alias(es): d
|
|
|
|
Type: `string`
|
|
|
|
Create the component under this directory (can be nested).
|
|
|
|
### export
|
|
|
|
Alias(es): e
|
|
|
|
Default: `false`
|
|
|
|
Type: `boolean`
|
|
|
|
When true, the component is exported from the project index.ts (if it exists).
|
|
|
|
### flat
|
|
|
|
Default: `false`
|
|
|
|
Type: `boolean`
|
|
|
|
Create component at the source root rather than its own directory.
|
|
|
|
### js
|
|
|
|
Default: `false`
|
|
|
|
Type: `boolean`
|
|
|
|
Generate JavaScript files rather than TypeScript files.
|
|
|
|
### name
|
|
|
|
Type: `string`
|
|
|
|
The name of the component.
|
|
|
|
### project
|
|
|
|
Alias(es): p
|
|
|
|
Type: `string`
|
|
|
|
The name of the project.
|
|
|
|
### skipTests
|
|
|
|
Default: `false`
|
|
|
|
Type: `boolean`
|
|
|
|
When true, does not create "spec.ts" test files for the new component.
|
|
|
|
### style
|
|
|
|
Alias(es): s
|
|
|
|
Default: `css`
|
|
|
|
Type: `string`
|
|
|
|
Possible values: `css`, `scss`, `styl`, `less`, `styled-components`, `@emotion/styled`, `none`
|
|
|
|
The file extension to be used for style files.
|