@nx/reactSee schema

@nx/react:hook

Create a React component using Hooks in a dedicated React project.

Usage

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

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

You can specify the collection explicitly as follows:

1nx g @nx/react:hook ... 2

Show what will be generated without writing to disk:

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

Examples

Generate a hook my-hook in the mylib library:

1nx g hook mylib/my-hook 2

Options

name

Required
string

The hook symbol name. It not provided, it defaults to the last segment of the provided path.

path

string

The file path to the hook without the file extension (e.g. my-app/src/app/my-hook/use-my-hook generates the file my-app/src/app/my-hook/use-my-hook.ts). Relative to the current working directory.

export

e
boolean
Default: false

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

js

boolean
Default: false

Generate JavaScript files rather than TypeScript files.

skipTests

Internal
boolean
Default: false

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