@nrwl/reactSee schema

@nrwl/react:hook

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

Usage

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

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

You can specify the collection explicitly as follows:

nx g @nrwl/react:hook ...

Show what will be generated without writing to disk:

nx g hook ... --dry-run

Examples

Generate a hook in the mylib library:

nx g hook my-hook --project=mylib

Options

directory

string

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

name

Required
string

The name of the hook.

project

pRequired
string

The name of the project.

export

e
boolean
Default: false

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

flat

boolean
Default: false

Create hook 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 hook file name (e.g. useHook.ts).

pascalCaseDirectory

R
boolean
Default: false

Use pascal case directory name (e.g. useHook/useHook.ts).

skipTests

boolean
Default: false

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