@nx/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 @nx/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
name
Required
string
The name of the hook.
project
pRequired
string
The name of the project.
directory
string
Create the hook under this directory (can be nested).
export
e
boolean
Default:
falseWhen true, the hook is exported from the project index.ts (if it exists).
flat
boolean
Default:
falseCreate hook at the source root rather than its own directory.
js
boolean
Default:
falseGenerate JavaScript files rather than TypeScript files.
pascalCaseFiles
P
boolean
Default:
falseUse pascal case hook file name (e.g. useHook.ts).
pascalCaseDirectory
R
boolean
Default:
falseUse pascal case directory name (e.g. useHook/useHook.ts).
skipTests
boolean
Default:
falseWhen true, does not create spec.ts test files for the new hook.