Security News
JavaScript Leaders Demand Oracle Release the JavaScript Trademark
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
@astrojs/vue
Advanced tools
This Astro integration enables server-side rendering and client-side hydration for your Vue 3 components.
There are two ways to add integrations to your project. Let's try the most convenient option first!
astro add
commandAstro includes a CLI tool for adding first party integrations: astro add
. This command will:
astro.config.*
file to apply this integrationTo install @astrojs/vue
, run the following from your project directory and follow the prompts:
# Using NPM
npx astro add vue
# Using Yarn
yarn astro add vue
# Using PNPM
pnpm 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
integration like so:
npm install @astrojs/vue
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:
npm install vue
Now, apply this 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:
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-')
}
})
],
});
FAQs
Use Vue components within Astro
The npm package @astrojs/vue receives a total of 16,116 weekly downloads. As such, @astrojs/vue popularity was classified as popular.
We found that @astrojs/vue demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.