Skip to content

react

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

react

README.md

@astrojs/react ⚛️

This Astro integration enables server-side rendering and client-side hydration for your React components.

Documentation

Read the @astrojs/react docs

React Compiler

Install the optional Oxc compiler:

pnpm add -D oxc-transform-react

Enable it in astro.config.mjs:

import react from '@astrojs/react';
import { defineConfig } from 'astro/config';

export default defineConfig({
  integrations: [react({ compiler: true })],
});

The compiler automatically memoizes client components and hooks. It does not compile server rendering. The target defaults to your installed React major version. For React 17 or 18, also install react-compiler-runtime as a runtime dependency.

Pass an options object, such as compiler: { compilationMode: 'annotation' }, to configure Oxc's React Compiler. The integration's include and exclude filters apply; dependencies and Astro files are excluded. Compilation is disabled by default.

Migrating custom Babel transforms

The integration uses @vitejs/plugin-react v6 and Oxc for JSX and Fast Refresh. The babel integration option has been removed in this major release.

If you use custom Babel transforms, install @rolldown/plugin-babel and @babel/core, keeping your existing Babel plugins and presets installed:

pnpm add -D @rolldown/plugin-babel @babel/core

Move your Babel plugins and presets from react({ babel: ... }) to babel() in vite.plugins. For example, migrate a project using babel-plugin-styled-components from:

import react from '@astrojs/react';
import { defineConfig } from 'astro/config';

export default defineConfig({
  integrations: [react({ babel: { plugins: ['babel-plugin-styled-components'] } })],
});

To:

import react from '@astrojs/react';
import babel from '@rolldown/plugin-babel';
import { defineConfig } from 'astro/config';

export default defineConfig({
  integrations: [react()],
  vite: {
    plugins: [
      babel({
        plugins: ['babel-plugin-styled-components'],
      }),
    ],
  },
});

This also works with react({ compiler: true }). Babel runs before Oxc transforms TypeScript and JSX. The Babel plugin automatically enables parsing for .jsx, .ts, and .tsx files. It does not load babel.config.js or .babelrc files; pass the options directly to babel(). The old babel callback is not supported; use the plugin's overrides and preset hooks for conditional transforms.

Do not enable babel-plugin-react-compiler on the same components as the Oxc compiler.

Support

Contributing

This package is maintained by Astro's Core team. You're welcome to submit an issue or PR! These links will help you get started:

License

MIT

Copyright (c) 2023–present Astro