Zum Inhalt springen

@astrojs/ vue

Dieser Inhalt ist noch nicht in deiner Sprache verfügbar.

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

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

Terminal window
npx astro add vue

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

First, install the @astrojs/vue package:

Terminal window
npm install @astrojs/vue

Most package managers will install associated peer dependencies as well. If you see a “Cannot find package ‘vue’” (or similar) warning when you start up Astro, you’ll need to install Vue:

Terminal window
npm install vue

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

astro.config.mjs
import { defineConfig } from 'astro/config';
import vue from '@astrojs/vue';
export default defineConfig({
// ...
integrations: [vue()],
});

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

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.

This package is maintained by Astro’s Core team. You’re welcome to submit an issue or PR!

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.

astro.config.mjs
import { defineConfig } from 'astro/config';
import vue from '@astrojs/vue';
export default defineConfig({
// ...
integrations: [
vue({
template: {
compilerOptions: {
// treat any tag that starts with ion- as custom elements
isCustomElement: (tag) => tag.startsWith('ion-'),
},
},
// ...
}),
],
});

You can extend the Vue app instance setting the appEntrypoint option to a root-relative import specifier (for example, appEntrypoint: "/src/pages/_app").

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.

astro.config.mjs
import { defineConfig } from 'astro/config';
import vue from '@astrojs/vue';
export default defineConfig({
// ...
integrations: [vue({ appEntrypoint: '/src/pages/_app' })],
});
src/pages/_app.ts
import type { App } from 'vue';
import i18nPlugin from 'my-vue-i18n-plugin';
export default (app: App) => {
app.use(i18nPlugin);
};

You can use Vue JSX by setting jsx: true.

astro.config.mjs
import { defineConfig } from 'astro/config';
import vue from '@astrojs/vue';
export default defineConfig({
// ...
integrations: [vue({ jsx: true })],
});

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.

astro.config.mjs
import { defineConfig } from 'astro/config';
import vue from '@astrojs/vue';
export default defineConfig({
// ...
integrations: [
vue({
jsx: {
// treat any tag that starts with ion- as custom elements
isCustomElement: (tag) => tag.startsWith('ion-'),
},
}),
],
});

Hinzugefügt in: @astrojs/vue@4.2.0

You can enable Vue DevTools in development by passing an object with devtools: true to your vue() integration config:

astro.config.mjs
import { defineConfig } from 'astro/config';
import vue from '@astrojs/vue';
export default defineConfig({
// ...
integrations: [vue({ devtools: true })],
});

Hinzugefügt in: @astrojs/vue@4.3.0

For more customization, you can instead pass options that the Vue DevTools Vite Plugin supports. (Note: appendTo is not supported.)

For example, you can set launchEditor to your preferred editor if you are not using Visual Studio Code:

astro.config.mjs
import { defineConfig } from "astro/config";
import vue from "@astrojs/vue";
export default defineConfig({
// ...
integrations: [
vue({
devtools: { launchEditor: "webstorm" },
}),
],
});

Weitere Integrationen

UI-Frameworks

SSR-Adapter

Sonstiges

Wirke mit

Worum geht es?

Community