تخطَّ إلى المحتوى

@astrojs/ preact

v3.2.0 GitHub npm Changelog

هذا المحتوى لا يتوفر بلغتك بعد.

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

Why Preact?

Section titled Why Preact?

Preact is a library that lets you build interactive UI components for the web. If you want to build interactive features on your site using JavaScript, you may prefer using its component format instead of using browser APIs directly.

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.

Installation

Section titled Installation

Astro includes an astro add command to automate the setup of official integrations. If you prefer, you can install integrations manually instead.

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

Terminal window
npx astro add preact

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

Manual Install

Section titled Manual Install

First, install the @astrojs/preact package:

Terminal window
npm install @astrojs/preact

Most package managers will install associated peer dependencies as well. If you see a “Cannot find package ‘preact’” (or similar) warning when you start up Astro, you’ll need to install Preact:

Terminal window
npm install preact

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

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


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

Usage

Section 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.

Configuration

Section 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.

compat

Section 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: true.

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


export default defineConfig({
  integrations: [preact({ compat: true })],
});

With the 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 and react-dom dependencies as preact/compat, you can use overrides to do so.

package.json
{
  "overrides": {
    "react": "npm:@preact/compat@latest",
    "react-dom": "npm:@preact/compat@latest"
  }
}

Check out the pnpm overrides and yarn resolutions docs for their respective overrides features.

devtools

Section titled devtools

أُضيفت في: @astrojs/preact@3.3.0 تجريبي

You can enable Preact devtools in development by passing an object with devtools: true to your preact() integration config:

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


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

Options

Section titled Options

Combining multiple JSX frameworks

Section 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.

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/*'],
    }),
  ],
});

Examples

Section 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.

More integrations

أطر عمل الواجهات

محولات تصيير على الخادم SSR

أخرى