@astrojs/ solid-js
This Astro integration enables server-side rendering and client-side hydration for your SolidJS components.
Installation
Section titled InstallationAstro 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:
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 InstallFirst, install the @astrojs/solid-js
package:
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:
Then, apply the integration to your astro.config.*
file using the integrations
property:
Getting started
Section titled Getting startedTo 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
Section titled OptionsCombining multiple JSX frameworks
Section titled Combining multiple JSX frameworksWhen 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:
Usage
Section titled UsageUse a SolidJS component as you would any UI framework component.
Suspense Boundaries
Section titled Suspense BoundariesIn 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 the server. The remote data will be included in the initial server-rendered HTML from Astro:
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.