Why Preact?Section titled Why Preact?
Preact is also a great choice if you have previously used React. Preact provides the same API as React, but in a much smaller 3kB package. It even supports rendering many React components using the
compat configuration option (see below).
Want to learn more about Preact before using this integration?
Check out “Learn Preact in 10 minutes”, an interactive tutorial on their website.
InstallationSection titled Installation
Quick InstallSection titled Quick Install
astro add command-line tool automates the installation for you. Run one of the following commands in a new terminal window. (If you aren’t sure which package manager you’re using, run the first command.) Then, follow the prompts, and type “y” in the terminal (meaning “yes”) for each one.
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
@astrojs/preact package using your package manager. If you’re using npm or aren’t sure, run this in the terminal:
Most package managers will install associated peer dependencies as well. Still, if you see a “Cannot find package ‘preact’” (or similar) warning when you start up Astro, you’ll need to install Preact:
Then, apply this integration to your
astro.config.* file using the
UsageSection titled Usage
To use your first Preact 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.
ConfigurationSection titled Configuration
The Astro Preact integration handles how Preact components are rendered and it has its own options. Change these in the
astro.config.mjs file which is where your project’s integration settings live.
For basic usage, you do not need to configure the Preact integration.
compatSection titled compat
You can enable
preact/compat, Preact’s compatibility layer for rendering React components without needing to install or ship React’s larger libraries to your users’ web browsers.
To do so, pass an object to the Preact integration and set
compat option enabled, the Preact integration will render React components as well as Preact components in your project and also allow you to import React components inside Preact components. Read more in “Switching to Preact (from React)” on the Preact website.
When importing React component libraries, in order to swap out the
react-dom dependencies as
preact/compat, you can use
overrides to do so.
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:
ExamplesSection titled Examples
- The Astro Preact example shows how to use an interactive Preact component in an Astro project.
- The Astro Nanostores example shows how to share state between different components — and even different frameworks! — in an Astro project.
TroubleshootingSection titled 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.
ContributingSection titled Contributing
This package is maintained by Astro’s Core team. You’re welcome to submit an issue or PR!
ChangelogSection titled Changelog
See CHANGELOG.md for a history of changes to this integration.