@nx/react-nativeSee schema

@nx/react-native:component

Create a React native Component for Nx.

Usage

1nx generate component ... 2
1nx g c ... #same 2

By 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-native:component ... 2

Show what will be generated without writing to disk:

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

Examples

Generate a component with the exported symbol matching the file name. It results in the component Foo at mylib/src/lib/foo.tsx:

1nx g @nx/react-native:component mylib/src/lib/foo.tsx 2

Generate a component with the exported symbol different from the file name. It results in the component Custom at mylib/src/lib/foo.tsx:

1nx g @nx/react-native:component mylib/src/lib/foo.tsx --name=custom 2

Generate a component without providing the file extension. It results in the component Foo at mylib/src/lib/foo.tsx:

1nx g @nx/react-native:component mylib/src/lib/foo 2

Generate a class component at mylib/src/lib/foo.tsx:

1nx g @nx/react-native:component mylib/src/lib/foo --classComponent 2

Options

path

Required
string

The file path to the component. Relative to the current working directory.

classComponent

C
boolean
Default: false

Use class components instead of functional component.

export

e
boolean
Default: false

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

name

string

The component symbol name. Defaults to the last segment of the file path.

skipTests

boolean
Default: false

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

skipFormat

Internal
boolean
Default: false

Skip formatting files.

js

Deprecated
boolean

Generate JavaScript files rather than TypeScript files.

Provide the full file path including the file extension in the path option. This option will be removed in Nx v21.