InstallationSection titled Installation
There are two ways to add integrations to your project. Let’s try the most convenient option first!
Section titled astro add command
astro add command
Astro 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
@astrojs/vue, 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 manuallySection titled Install dependencies manually
First, install the
@astrojs/vue integration like so:
Most package managers will install associated peer dependencies as well. Still, if you see a “Cannot find package ‘vue’” (or similar) warning when you start up Astro, you’ll need to install Vue:
Now, apply this integration to your
astro.config.* file using the
Getting startedSection titled Getting started
To use your first Vue 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
TroubleshootingSection titled Troubleshooting
For 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.
ContributingSection titled Contributing
This package is maintained by Astro’s Core team. You’re welcome to submit an issue or PR!
OptionsSection titled Options
This integration is powered by
@vitejs/plugin-vue. To customize the Vue compiler, options can be provided to the integration. See the
@vitejs/plugin-vue docs for more details.
appEntrypointSection titled appEntrypoint
You can extend the Vue
app instance setting the
appEntrypoint option to a root-relative import specifier (for example,
The default export of this file should be a function that accepts a Vue
App instance prior to rendering, allowing the use of custom Vue plugins,
app.use, and other customizations for advanced use cases.
You can use Vue JSX by setting
This will enable rendering for both Vue and Vue JSX components. To customize the Vue JSX compiler, pass an options object instead of a boolean. See the
@vitejs/plugin-vue-jsx docs for more details.