solid-js.mdx

type	title	description	githubIntegrationURL	category	i18nReady
integration	@astrojs/solid-js	Learn how to use the @astrojs/solid-js framework integration to extend component support in your Astro project.	https://github.com/withastro/astro/tree/main/packages/integrations/solid/	renderer	true

import PackageManagerTabs from '~/components/tabs/PackageManagerTabs.astro'

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

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/solid-js, run the following from your project directory and follow the prompts:

```sh npx astro add solid ``` ```sh pnpm astro add solid ``` ```sh yarn astro add solid ```

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

Manual Install

First, install the @astrojs/solid-js package:

```sh npm install @astrojs/solid-js ``` ```sh pnpm add @astrojs/solid-js ``` ```sh yarn add @astrojs/solid-js ```

Most package managers will install associated peer dependencies as well. If you see a Cannot find package 'solid-js' (or similar) warning when you start up Astro, you'll need to install SolidJS:

```sh npm install solid-js ``` ```sh pnpm add solid-js ``` ```sh yarn add solid-js ```

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

import { defineConfig } from 'astro/config';
import solid from '@astrojs/solid-js';

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

Getting started

To use your first SolidJS 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

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:

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

Usage

Use a SolidJS component as you would any UI framework component.

Suspense Boundaries

In order to support Solid Resources and Lazy Components without excessive configuration, server-only and hydrating components are automatically wrapped in top-level Suspense boundaries and rendered on the server using the renderToStringAsync function. Therefore, you do not need to add a top-level Suspense boundary around async components.

For example, you can use Solid's createResource to fetch async remote data on the server. The remote data will be included in the initial server-rendered HTML from Astro:

// CharacterName.tsx
function CharacterName() {
  const [name] = createResource(() =>
    fetch('https://swapi.dev/api/people/1')
      .then((result) => result.json())
      .then((data) => data.name)
  );

  return (
    <>
      <h2>Name:</h2>
      {/* Luke Skywalker */}
      <div>{name()}</div>
    </>
  );
}

Similarly, Solid's Lazy Components will also be resolved and their HTML will be included in the initial server-rendered page.

Non-hydrating client:only components are not automatically wrapped in Suspense boundaries.

Feel free to add additional Suspense boundaries according to your preference.