InstallationSection titled Installation
Astro includes an
astro add command to automate the setup of official integrations. If you prefer, you can install integrations manually instead.
@astrojs/react, run the following from your project directory and follow the prompts:
If you run into any issues, feel free to report them to us on GitHub and try the manual installation steps below.
Manual InstallSection titled Manual Install
First, install the
Most package managers will install associated peer dependencies as well. If you see a “Cannot find package ‘react’” (or similar) warning when you start up Astro, you’ll need to install
Then, apply the integration to your
astro.config.* file using the
Getting startedSection titled 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
OptionsSection titled Options
Combining multiple JSX frameworksSection titled 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.
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/solid/) to make specifying your includes easier, but this is not required:
Children parsingSection titled 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:
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: