e3c030e5d3
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> |
||
---|---|---|
.. | ||
src | ||
test | ||
CHANGELOG.md | ||
client-v17.js | ||
client.js | ||
context.js | ||
jsx-runtime.js | ||
package.json | ||
README.md | ||
server-v17.js | ||
server.js | ||
static-html.js | ||
tsconfig.json | ||
vnode-children.js |
@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:
- (Optionally) Install all necessary dependencies and peer dependencies
- (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
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 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!