#ReactLynx

Learn how to build a ReactLynx application for Lynx using Rsbuild.

#Create a ReactLynx application

Create a ReactLynx application with @lynx-js/create-lynx:

npm create @lynx-js/lynx@latest

yarn create @lynx-js/lynx

pnpm create @lynx-js/lynx@latest

bun create @lynx-js/lynx@latest

Then select Rsbuild when prompted to "Select build tool".

#Use ReactLynx in an existing project

To compile ReactLynx, you need to register the ReactLynx plugin provided by Lynx. The plugin will automatically add the necessary configuration for ReactLynx builds.

Install @lynx-js/react and the plugin:

npm add @lynx-js/react

yarn add @lynx-js/react

pnpm add @lynx-js/react

bun add @lynx-js/react

deno add npm:@lynx-js/react

npm add @lynx-js/react-rsbuild-plugin -D

yarn add @lynx-js/react-rsbuild-plugin -D

pnpm add @lynx-js/react-rsbuild-plugin -D

bun add @lynx-js/react-rsbuild-plugin -D

deno add npm:@lynx-js/react-rsbuild-plugin -D

Then register the plugin in Rsbuild config, and name the environment lynx so that it is built into a Lynx bundle:

import { defineConfig } from '@rsbuild/core';
import { pluginReactLynx } from '@lynx-js/react-rsbuild-plugin';

export default defineConfig({
  environments: {
    lynx: {},
  },
  plugins: [pluginReactLynx()],
});

For more details, see the ReactLynx documentation.