2022-03-25 17:54:18 -05:00
# @astrojs/solid-js 💙
2022-03-25 11:15:38 -05:00
This ** [Astro integration][astro-integration]** enables server-side rendering and client-side hydration for your [SolidJS ](https://www.solidjs.com/ ) components.
## Installation
There are two ways to add integrations to your project. Let's try the most convenient option first!
2022-06-27 13:44:32 -05:00
### `astro add` command
2022-03-25 11:15:38 -05:00
Astro includes a CLI tool for adding first party integrations: `astro add` . This command will:
2023-06-25 22:34:13 -05:00
2022-03-25 11:15:38 -05:00
1. (Optionally) Install all necessary dependencies and peer dependencies
2. (Also optionally) Update your `astro.config.*` file to apply this integration
2022-03-25 17:54:18 -05:00
To install `@astrojs/solid-js` , run the following from your project directory and follow the prompts:
2022-03-25 11:15:38 -05:00
```sh
# Using NPM
2022-09-07 05:08:58 -05:00
npx astro add solid
2022-03-25 11:15:38 -05:00
# Using Yarn
yarn astro add solid
# Using PNPM
2022-08-16 03:31:14 -05:00
pnpm astro add solid
2022-03-25 11:15:38 -05:00
```
2022-09-07 05:08:58 -05:00
If you run into any issues, [feel free to report them to us on GitHub ](https://github.com/withastro/astro/issues ) and try the manual installation steps below.
2022-03-25 11:15:38 -05:00
### Install dependencies manually
2022-03-25 17:54:18 -05:00
First, install the `@astrojs/solid-js` integration like so:
2022-03-25 11:15:38 -05:00
2022-07-11 14:10:34 -05:00
```sh
2022-03-25 17:54:18 -05:00
npm install @astrojs/solid -js
2022-03-25 11:15:38 -05:00
```
Most package managers will install associated peer dependencies as well. Still, 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
```
Now, apply this integration to your `astro.config.*` file using the `integrations` property:
2023-06-25 22:34:13 -05:00
**`astro.config.mjs`**
2022-03-25 11:15:38 -05:00
2023-01-26 14:03:00 -05:00
```js ins={2} "solid()"
import { defineConfig } from 'astro/config';
2022-03-25 17:54:18 -05:00
import solid from '@astrojs/solid-js';
2022-03-25 11:15:38 -05:00
2023-01-26 14:03:00 -05:00
export default defineConfig({
2023-06-25 22:34:13 -05:00
// ...
integrations: [solid()],
2023-01-26 14:03:00 -05:00
});
2022-03-25 11:15:38 -05:00
```
## Getting started
To use your first SolidJS component in Astro, head to our [UI framework documentation][astro-ui-frameworks]. You'll explore:
2023-06-25 22:34:13 -05:00
2022-03-25 11:15:38 -05:00
- 📦 how framework components are loaded,
- 💧 client-side hydration options, and
2022-09-19 10:58:06 -05:00
- 🤝 opportunities to mix and nest frameworks together
2022-03-25 11:15:38 -05:00
2022-09-26 09:14:34 -05:00
## Troubleshooting
For help, check out the `#support` channel on [Discord ](https://astro.build/chat ). Our friendly Support Squad members are here to help!
You can also check our [Astro Integration Documentation][astro-integration] for more on integrations.
## Contributing
This package is maintained by Astro's Core team. You're welcome to submit an issue or PR!
2022-03-25 11:15:38 -05:00
[astro-integration]: https://docs.astro.build/en/guides/integrations-guide/
2022-03-25 17:54:18 -05:00
[astro-ui-frameworks]: https://docs.astro.build/en/core-concepts/framework-components/#using-framework-components