@nx/react:hook
Create a React component using Hooks in a dedicated React project.
Usage
1nx generate hook ...
21nx g c ... #same
2By 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 ...
2Show what will be generated without writing to disk:
1nx g hook ... --dry-run
2Examples
Generate a hook with the exported symbol matching the file name. It results in the hook useFoo at mylib/src/lib/foo.ts:
1nx g @nx/react:hook mylib/src/lib/foo
2Generate a hook with the exported symbol different from the file name. It results in the hook useCustom at mylib/src/lib/foo.ts:
1nx g @nx/react:hook mylib/src/lib/foo --name=useCustom
2Options
path
Required
string
The file path to the hook without the file extension. Relative to the current working directory.
export
e
boolean
Default:
falseWhen true, the hook is exported from the project index.ts (if it exists).
js
boolean
Default:
falseGenerate JavaScript files rather than TypeScript files.
name
string
The hook symbol name. Defaults to the last segment of the file path.
skipTests
Internal
boolean
Default:
falseWhen true, does not create spec.ts test files for the new hook.