@astrojs/react

What is @astrojs/react?

@astrojs/react is an integration package for Astro, a modern static site generator, that allows developers to use React components within their Astro projects. This package enables seamless interoperability between Astro and React, allowing developers to leverage React's component model and ecosystem within the Astro framework.

What are @astrojs/react's main functionalities?

Using React Components in Astro

This feature allows developers to import and use React components directly within Astro files. The code sample demonstrates how to import a React component and use it in an Astro file, passing props as needed.

```jsx
// Example of using a React component in an Astro file
---
import ReactComponent from '../components/ReactComponent.jsx';
---

<ReactComponent message="Hello from React!" />
```

Hydration Control

Astro provides fine-grained control over when and how React components are hydrated on the client-side. The code sample shows how to use the `client:load` directive to specify that a React component should hydrate when the page loads.

```jsx
// Example of controlling hydration in Astro with React
---
import ReactComponent from '../components/ReactComponent.jsx';
---

<ReactComponent client:load message="This component hydrates on load!" />
```

Other packages similar to @astrojs/react

@astrojs/vue

@astrojs/vue is similar to @astrojs/react but for Vue.js components. It allows developers to use Vue components within Astro projects, providing similar integration and hydration controls as @astrojs/react.

@astrojs/svelte

@astrojs/svelte enables the use of Svelte components in Astro projects. Like @astrojs/react, it offers seamless integration and hydration options, but for the Svelte framework.

vite-plugin-react

vite-plugin-react is a Vite plugin that provides React support for Vite projects. While it is not specific to Astro, it offers similar functionality in terms of enabling React component usage in a modern build tool environment.

README

@astrojs/react ⚛️

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

Installation

There are two ways to add integrations to your project. Let's try the most convenient option first!

astro add command

Astro includes a CLI tool for adding first party integrations: astro add. This command will:

1. (Optionally) Install all necessary dependencies and peer dependencies
2. (Also optionally) Update your astro.config.* file to apply this integration

To install @astrojs/react, run the following from your project directory and follow the prompts:

# Using NPM
npx astro add react
# Using Yarn
yarn astro add react
# Using PNPM
pnpm astro add react

If you run into any issues, feel free to report them to us on GitHub and try the manual installation steps below.

Install dependencies manually

First, install the @astrojs/react integration like so:

npm install @astrojs/react

Most package managers will install associated peer dependencies as well. Still, if you see a "Cannot find package 'react'" (or similar) warning when you start up Astro, you'll need to install react and react-dom:

npm install react react-dom

Now, apply this integration to your astro.config.* file using the integrations property:

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

  export default defineConfig({
    // ...
    integrations: [react()],
    //             ^^^^^^^
  });

Getting started

To use your first React component in Astro, head to our UI framework documentation. You'll explore:

• 📦 how framework components are loaded,
• 💧 client-side hydration options, and
• 🤝 opportunities to mix and nest frameworks together

Options

Combining multiple JSX frameworks

When you are using multiple JSX frameworks (React, Preact, Solid) in the same project, Astro needs to determine which JSX framework-specific transformations should be used for each of your components. If you have only added one JSX framework integration to your project, no extra configuration is needed.

Use the include (required) and exclude (optional) configuration options to specify which files belong to which framework. Provide an array of files and/or folders to include for each framework you are using. Wildcards may be used to include multiple file paths.

We recommend placing common framework components in the same folder (e.g. /components/react/ and /components/solid/) to make specifying your includes easier, but this is not required:

// astro.config.mjs
import { defineConfig } from 'astro/config';
import preact from '@astrojs/preact';
import react from '@astrojs/react';
import svelte from '@astrojs/svelte';
import vue from '@astrojs/vue';
import solid from '@astrojs/solid-js';

export default defineConfig({
  // Enable many frameworks to support all different kinds of components.
  // No `include` is needed if you are only using a single JSX framework!
  integrations: [
    preact({
      include: ['**/preact/*'],
    }),
    react({
      include: ['**/react/*'],
    }),
    solid({
      include: ['**/solid/*'],
    }),
  ],
});

Children parsing

Children passed into a React component from an Astro component are parsed as plain strings, not React nodes.

For example, the <ReactComponent /> below will only receive a single child element:

---
import ReactComponent from './ReactComponent';
---

<ReactComponent>
  <div>one</div>
  <div>two</div>
</ReactComponent>

If you are using a library that expects more than one child element to be passed, for example so that it can slot certain elements in different places, you might find this to be a blocker.

You can set the experimental flag experimentalReactChildren to tell Astro to always pass children to React as React vnodes. There is some runtime cost to this, but it can help with compatibility.

You can enable this option in the configuration for the React integration:

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

export default defineConfig({
  // ...
  integrations: [
    react({
      experimentalReactChildren: true,
    }),
  ],
});

Troubleshooting

For help, check out the #support channel on Discord. Our friendly Support Squad members are here to help!

You can also check our Astro Integration Documentation for more on integrations.

Contributing

This package is maintained by Astro's Core team. You're welcome to submit an issue or PR!