66eaf2fc74
This PR removes the `/nx-api` pages from `nx-dev`. They are already redirected from `/nx-api` to either `/technologies` or `/reference/core-api` URLs. e.g. `/nx-api/nx` goes to `/reference/core-api/nx` and `/nx-api/react` goes to `/technologies/react/api` **Changes**: - Remove old `nx-api.json` from being generated in `scripts/documentation/generators/generate-manifests.ts` -- this was used to generate the sitemap - Remove `pages/nx-api` from Next.js app since we don't need them - Remove workaround from link checker `scripts/documentation/internal-link-checker.ts` -- the angular rspack/rsbuild and other workarounds are gone now that they are proper docs in `map.json` - Update Powerpack/Remote Cache reference docs to exclude API documents (since they are duplicated in the Intro page) -- `nx-dev/models-document/src/lib/mappings.ts` - All content in `docs` have been updated with new URL structure **Note:** Redirects are already handled, and Claude Code was used to verify the updated `docs/` URLs (see report below). The twelve 404s links were updated by hand. ## Verification Report https://gist.github.com/jaysoo/c7863fe7e091cb77929d1976165c357a
142 lines
4.0 KiB
Markdown
142 lines
4.0 KiB
Markdown
---
|
|
title: React Plugin for Nx
|
|
description: Learn how to use the @nx/react plugin to create and manage React applications and libraries in your Nx workspace, including components, hooks, and more.
|
|
keywords: [react]
|
|
---
|
|
|
|
The React plugin contains executors and generators for managing React applications and libraries within an Nx workspace.
|
|
It provides:
|
|
|
|
- Integration with libraries such as Jest, Cypress, and Storybook.
|
|
- Generators for applications, libraries, components, hooks, and more.
|
|
- Library build support for publishing packages to npm or other registries.
|
|
- Utilities for automatic workspace refactoring.
|
|
|
|
## Setting Up @nx/react
|
|
|
|
### Generating a new Workspace
|
|
|
|
To create a new workspace with React, run `npx create-nx-workspace@latest --preset=react-standalone`.
|
|
|
|
{% callout type="note" title="React Tutorial" %}
|
|
For a full tutorial experience, follow the [React Monorepo Tutorial](/getting-started/tutorials/react-monorepo-tutorial)
|
|
{% /callout %}
|
|
|
|
### Installation
|
|
|
|
{% callout type="note" title="Keep Nx Package Versions In Sync" %}
|
|
Make sure to install the `@nx/react` version that matches the version of `nx` in your repository. If the version numbers get out of sync, you can encounter some difficult to debug errors. You can [fix Nx version mismatches with this recipe](/recipes/tips-n-tricks/keep-nx-versions-in-sync).
|
|
{% /callout %}
|
|
|
|
In any Nx workspace, you can install `@nx/react` by running the following command:
|
|
|
|
```shell {% skipRescope=true %}
|
|
nx add @nx/react
|
|
```
|
|
|
|
This will install the correct version of `@nx/react`.
|
|
|
|
## Using the @nx/react Plugin
|
|
|
|
### Creating Applications and Libraries
|
|
|
|
You can add a new application with the following:
|
|
|
|
```shell
|
|
nx g @nx/react:app apps/my-new-app
|
|
```
|
|
|
|
To start the application in development mode, run `nx serve my-new-app`.
|
|
|
|
And add a new library as follows:
|
|
|
|
```shell
|
|
nx g @nx/react:lib libs/my-new-lib
|
|
|
|
# If you want the library to be buildable or publishable to npm
|
|
nx g @nx/react:lib libs/my-new-lib --bundler=vite
|
|
nx g @nx/react:lib libs/my-new-lib --bundler=rollup
|
|
nx g @nx/react:lib libs/my-new-lib \
|
|
--publishable \
|
|
--importPath=@myorg/my-new-lib
|
|
```
|
|
|
|
Read more about [building and publishing libraries here](/concepts/buildable-and-publishable-libraries).
|
|
|
|
### Creating Components
|
|
|
|
Adding a component to an existing project can be done with:
|
|
|
|
```shell
|
|
nx g @nx/react:component libs/my-new-lib/src/lib/my-new-component
|
|
|
|
# Note: If you want to export the component
|
|
# from the library use --export
|
|
nx g @nx/react:component libs/my-new-lib/src/lib/my-new-component --export
|
|
```
|
|
|
|
Replace `my-new-app` and `my-new-lib` with the name of your projects.
|
|
|
|
### Creating Hooks
|
|
|
|
If you want to add a new hook, run the following
|
|
|
|
```shell
|
|
nx g @nx/react:hook libs/my-new-lib/src/lib/my-new-hook
|
|
```
|
|
|
|
Replace `my-new-lib` with the name of your project.
|
|
|
|
## Using React
|
|
|
|
### Testing Projects
|
|
|
|
You can run unit tests with:
|
|
|
|
```shell
|
|
nx test my-new-app
|
|
nx test my-new-lib
|
|
```
|
|
|
|
Replace `my-new-app` with the name or your project. This command works for both applications and libraries.
|
|
|
|
You can also run E2E tests for applications:
|
|
|
|
```shell
|
|
nx e2e my-new-app-e2e
|
|
```
|
|
|
|
Replace `my-new-app-e2e` with the name or your project with `-e2e` appended.
|
|
|
|
### Building Projects
|
|
|
|
React applications can be build with:
|
|
|
|
```shell
|
|
nx build my-new-app
|
|
```
|
|
|
|
And if you generated a library with `--bundler` specified, then you can build a library as well:
|
|
|
|
```shell
|
|
nx build my-new-lib
|
|
```
|
|
|
|
The output is in the `dist` folder. You can customize the output folder by setting `outputPath` in the
|
|
project's `project.json` file.
|
|
|
|
The application in `dist` is deployable, and you can try it out locally with:
|
|
|
|
```shell
|
|
npx http-server dist/apps/my-new-app
|
|
```
|
|
|
|
The library in `dist` is publishable to npm or a private registry.
|
|
|
|
## More Documentation
|
|
|
|
- [React Monorepo Tutorial](/getting-started/tutorials/react-monorepo-tutorial)
|
|
- [Using Cypress](/technologies/test-tools/cypress/api)
|
|
- [Using Jest](/technologies/test-tools/jest/api)
|
|
- [Using Storybook](/technologies/test-tools/storybook/recipes/overview-react)
|