48c9b142cc
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> |
||
---|---|---|
.. | ||
src | ||
CHANGELOG.md | ||
client-v17.js | ||
client.js | ||
jsx-runtime.js | ||
package.json | ||
README.md | ||
server-v17.js | ||
server.js | ||
static-html.js | ||
tsconfig.json |
@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!
(experimental) 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
pnpx astro add react
If you run into any hiccups, feel free to log an issue on our 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 react from '@astrojs/react';
export default {
// ...
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
Also check our Astro Integration Documentation for more on integrations.