@astrojs/svelte
This Astro integration enables server-side rendering and client-side hydration for your Svelte components.
Installation
Section titled InstallationThere are two ways to add integrations to your project. Let’s try the most convenient option first!
astro add
command
Section titled astro add commandAstro includes a CLI tool for adding first party integrations: astro add
. This command will:
- (Optionally) Install all necessary dependencies and peer dependencies
- (Also optionally) Update your
astro.config.*
file to apply this integration
To install @astrojs/svelte
, 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.
Install dependencies manually
Section titled Install dependencies manuallyFirst, install the @astrojs/svelte
integration like so:
Most package managers will install associated peer dependencies as well. Still, if you see a “Cannot find package ‘svelte’” (or similar) warning when you start up Astro, you’ll need to install Svelte:
Now, apply this integration to your astro.config.*
file using the integrations
property:
Getting started
Section titled Getting startedTo use your first Svelte 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
Troubleshooting
Section titled TroubleshootingFor 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.
Contributing
Section titled ContributingThis package is maintained by Astro’s Core team. You’re welcome to submit an issue or PR!
Options
Section titled OptionsThis integration is powered by @sveltejs/vite-plugin-svelte
. To customize the Svelte compiler, options can be provided to the integration. See the @sveltejs/vite-plugin-svelte
docs for more details.
Default options
Section titled Default optionsA few of the default options passed to the Svelte compiler are required to build properly for Astro and cannot be overridden.
The emitCss
, compilerOptions.dev
, and compilerOptions.hydratable
cannot be overridden.
Providing your own preprocess
options will override the defaults - make sure to enable the preprocessor flags needed for your project.