{{ title }}
\n \nAsk your question and get a summary of the document by referencing this page and the AI provider of your choice
Version History
- "Update Solid useIntlayer API usage to direct property access"v8.9.004/05/2026
- "Initial documentation for Astro + Vue"v8.7.724/04/2026
The content of this page was translated using an AI.
See the last version of the original content in EnglishIf you have an idea for improving this documentation, please feel free to contribute by submitting a pull request on GitHub.
GitHub link to the documentationCopy doc Markdown to clipboard
Translate your Astro + Vue site with Intlayer | Internationalisation (i18n)
Table of Contents
What is Intlayer?
Intlayer is an innovative, open-source internationalisation (i18n) library designed to simplify multilingual support in modern web applications.
With Intlayer, you can:
- Manage translations easily: Using declarative dictionaries at the component level.
- Localise metadata, routes and content dynamically.
- Ensure TypeScript support: With autogenerated types for better autocompletion and error detection.
- Benefit from advanced features: Such as dynamic language detection and switching.
Step-by-Step Guide to Configure Intlayer in Astro + Vue
Check out the application template on GitHub.
Step 1: Install Dependencies
Install the necessary packages using your preferred package manager:
Copy the code to the clipboard
npm install intlayer astro-intlayer vue vue-intlayer @astrojs/vuenpx intlayer initintlayer The core package that provides i18n tools for configuration management, translations, content declaration, transpilation, and CLI commands.
astro-intlayer Includes the Astro integration plugin to link Intlayer with the Vite bundler, as well as the middleware to detect the user's preferred language, manage cookies, and handle URL redirects.
vue Core Vue package.
vue-intlayer Package to integrate Intlayer into Vue applications. It provides
installIntlayeras well as theuseIntlayeranduseLocalecomposables for internationalisation in Vue.@astrojs/vue Official Astro integration that allows the use of Vue component islands.
Step 2: Configure Your Project
Create a configuration file to define your application's languages:
Copy the code to the clipboard
import { Locales, type IntlayerConfig } from "intlayer";const config: IntlayerConfig = { internationalization: { locales: [ Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH, Locales.ENGLISH_UNITED_KINGDOM, // Your other languages ], defaultLocale: Locales.ENGLISH, },};export default config;Through this configuration file, you can configure localised URLs, middleware redirects, cookie names, location and extensions of content declarations, disable Intlayer logs in the console, and more. For a full list of available parameters, refer to the configuration documentation.
Step 3: Integrate Intlayer into Your Astro Configuration
Add the intlayer plugin and Vue integration to your Astro configuration.
Copy the code to the clipboard
// @ts-checkimport { intlayer } from "astro-intlayer";import vue from "@astrojs/vue";import { defineConfig } from "astro/config";// https://astro.build/configexport default defineConfig({ integrations: [intlayer(), vue()],});The intlayer() integration plugin is used to integrate Intlayer with Astro. It ensures the generation of the content declaration files and monitors them in development mode. It defines Intlayer environment variables within the Astro application and provides aliases to optimise performance.
Thevue()integration allows for using Vue component islands viaclient:only="vue".
Step 4: Declare Your Content
Create and manage your content declarations to store translations:
Copy the code to the clipboard
import { t, type Dictionary } from "intlayer";const appContent = { key: "app", content: { title: t({ en: "Hello World", fr: "Bonjour le monde", es: "Hola mundo", "en-GB": "Hello World", }), },} satisfies Dictionary;export default appContent;Content declarations can be defined anywhere in your application, as long as they are included in thecontentDir(by default./src) and match the content declaration file extension (by default.content.{json,ts,tsx,js,jsx,mjs,cjs}).
For more information, refer to the content declaration documentation.
Step 5: Using Content in Astro
You can consume the dictionaries directly in your .astro files using the core helpers exported from intlayer. You should also add SEO metadata (such as hreflang and canonical links) to every page and introduce a Vue island for interactive client-side content.
Copy the code to the clipboard
---import { getIntlayer, getLocaleFromPath, getLocalizedUrl, getHTMLTextDir, getPrefix, localeMap, defaultLocale, type LocalesValues,} from "intlayer";import VueIsland from "../../components/vue/VueIsland.vue";export const getStaticPaths = () => { return localeMap(({ locale }) => ({ params: { locale: getPrefix(locale).localePrefix }, }));};const locale = getLocaleFromPath(Astro.url.pathname) as LocalesValues;const { title } = getIntlayer("app", locale);---<!doctype html><html lang={locale} dir={getHTMLTextDir(locale)}> <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width" /> <link rel="icon" type="image/svg+xml" href="/favicon.svg" /> <title>{title}</title> <!-- Canonical Link: Informs search engines about the main version of this page --> <link rel="canonical" href={new URL(getLocalizedUrl(Astro.url.pathname, locale), Astro.site)} /> <!-- Hreflang: Informs Google about all localised versions --> { localeMap(({ locale: mapLocale }) => ( <link rel="alternate" hreflang={mapLocale} href={new URL( getLocalizedUrl(Astro.url.pathname, mapLocale), Astro.site )} /> )) } <!-- x-default: Fallback option when locale doesn't match user's language --> <link rel="alternate" hreflang="x-default" href={new URL( getLocalizedUrl(Astro.url.pathname, defaultLocale), Astro.site )} /> </head> <body> <!-- The Vue island renders all interactive content, including the language switcher --> <VueIsland locale={locale} client:only="vue" /> </body></html>Note on routing setup: The directory structure you use depends on the
middleware.routingsetting inintlayer.config.ts:
prefix-no-default(default): keeps the default language at the root (no prefix) and prefixes others. Use[...locale]to catch all cases.prefix-all: all URLs get a language prefix. You can use standard[locale]if you don't need to handle the root separately.search-paramorno-prefix: no language directories are needed. The language is handled via query parameters or cookies.
Step 6: Create a Vue Island Component
Create an island component that wraps your Vue application and receives the server-detected locale. You must register the Intlayer plugin in your Vue instance by calling installIntlayer before using any composables.
Copy the code to the clipboard
<script setup lang="ts">import { ref, getCurrentInstance } from "vue";import { useIntlayer, useLocale, installIntlayer } from "vue-intlayer";import { getLocalizedUrl, getLocaleName, type LocalesValues } from "intlayer";const props = defineProps<{ locale: LocalesValues }>();const app = getCurrentInstance()?.appContext.app;if (app) { installIntlayer(app, { locale: props.locale });}const { locale: currentLocale, availableLocales, setLocale,} = useLocale({ onLocaleChange: (newLocale: LocalesValues) => { window.location.href = getLocalizedUrl(window.location.pathname, newLocale); },});const count = ref(0);const { title } = useIntlayer("app");</script><template> <div> <h1>{{ title }}</h1> <!-- The language switcher is rendered directly within the island template --> <div class="locale-switcher"> <span class="switcher-label">Change language:</span> <div class="locale-buttons"> <button v-for="localeItem in availableLocales" :key="localeItem" :class="['locale-btn', { active: localeItem === currentLocale }]" :disabled="localeItem === currentLocale" @click="setLocale(localeItem)" > <span class="ls-own-name">{{ getLocaleName(localeItem) }}</span> <span class="ls-current-name">{{ getLocaleName(localeItem, currentLocale) }}</span> <span class="ls-code">{{ localeItem.toUpperCase() }}</span> </button> </div> </div> </div></template>Thelocaleprop is passed from the Astro page (server detection) and used to initialiseinstallIntlayer, setting the initial language for all composables within the tree.
Step 7: Add a Language Switcher
The language switching functionality is integrated directly within the Vue island template (see step 6 above). It uses the useLocale composable from vue-intlayer and navigates to the localised URL when a user selects a new language:
Copy the code to the clipboard
<script setup lang="ts">import { useLocale } from "vue-intlayer";import { getLocalizedUrl, getLocaleName, type LocalesValues } from "intlayer";// Reuse the same prop/setup app logic from step 6...const { locale: currentLocale, availableLocales, setLocale,} = useLocale({ onLocaleChange: (newLocale: LocalesValues) => { // Navigate to the localised URL on language change window.location.href = getLocalizedUrl(window.location.pathname, newLocale); },});</script><template> <div class="locale-switcher"> <span class="switcher-label">Change language:</span> <div class="locale-buttons"> <button v-for="localeItem in availableLocales" :key="localeItem" :class="['locale-btn', { active: localeItem === currentLocale }]" :disabled="localeItem === currentLocale" @click="setLocale(localeItem)" > <span class="ls-own-name">{{ getLocaleName(localeItem) }}</span> <span class="ls-current-name">{{ getLocaleName(localeItem, currentLocale) }}</span> <span class="ls-code">{{ localeItem.toUpperCase() }}</span> </button> </div> </div></template>Note on persistence: Using
onLocaleChangeto redirect viawindow.location.hrefensures the new linguistic URL is visited, allowing the Intlayer middleware to set the language cookie and remember the user's preference in future visits.
Step 8: Sitemap and Robots.txt
Intlayer offers utilities to dynamically create your localised sitemap and robots.txt files.
Sitemap
Intlayer comes with a built-in sitemap generator to help you create a sitemap for your application easily. It handles localized routes and adds the necessary metadata for search engines.
The Intlayer generated sitemap supports thexhtml:linknamespace (Hreflang XML Extensions). Unlike the default sitemap generators that only list raw URLs, Intlayer automatically creates the required bidirectional links between all language versions of a page (e.g.,/about,/about?lang=fr, and/about?lang=es). This ensures search engines correctly index and serve the right language version to the right audience.
Create src/pages/sitemap.xml.ts to generate a sitemap including all your localised routes.
Copy the code to the clipboard
import type { APIRoute } from "astro";import { generateSitemap, type SitemapUrlEntry } from "intlayer";const pathList: SitemapUrlEntry[] = [ { path: "/", changefreq: "daily", priority: 1.0 }, { path: "/about", changefreq: "monthly", priority: 0.7 },];const SITE_URL = import.meta.env.SITE ?? "http://localhost:4321";export const GET: APIRoute = async ({ site }) => { const xmlOutput = generateSitemap(pathList, { siteUrl: SITE_URL }); return new Response(xmlOutput, { headers: { "Content-Type": "application/xml" }, });};Robots.txt
Create src/pages/robots.txt.ts to control search engine crawling.
Copy the code to the clipboard
import type { APIRoute } from "astro";import { getMultilingualUrls } from "intlayer";const getAllMultilingualUrls = (urls: string[]) => urls.flatMap((url) => Object.values(getMultilingualUrls(url)) as string[]);const disallowedPaths = getAllMultilingualUrls(["/admin", "/private"]);export const GET: APIRoute = ({ site }) => { const robotsTxt = [ "User-agent: *", "Allow: /", ...disallowedPaths.map((path) => `Disallow: ${path}`), "", `Sitemap: ${new URL("/sitemap.xml", site).href}`, ].join("\n"); return new Response(robotsTxt, { headers: { "Content-Type": "text/plain" }, });};TypeScript Configuration
Intlayer uses module augmentation to leverage TypeScript, making your codebase more robust.


Ensure your TypeScript configuration includes the autogenerated types.
Copy the code to the clipboard
{ // ... your existing TypeScript configuration "include": [ // ... your existing TypeScript configuration ".intlayer/**/*.ts", // Include autogenerated types ],}Git Configuration
It is recommended to ignore the files generated by Intlayer. This avoids committing them to your Git repository.
To do this, add the following instructions to your .gitignore file:
Copy the code to the clipboard
# Ignore the files generated by Intlayer.intlayerVS Code Extension
To improve your development experience with Intlayer, you can install the official Intlayer VS Code extension.
Installation from the VS Code Marketplace
This extension provides:
- Autocompletion for translation keys.
- Real-time error detection for missing translations.
- Inline preview of translated content.
- Quick actions for easily creating and updating translations.
For more information on using the extension, refer to the VS Code Extension documentation.
(Optional) Step 15: Extract the content of your components
If you have an existing codebase, transforming thousands of files can be time-consuming.
To ease this process, Intlayer propose a compiler / extractor to transform your components and extract the content.
To set it up, you can add a compiler section in your intlayer.config.ts file:
Copy the code to the clipboard
import { type IntlayerConfig } from "intlayer";
const config: IntlayerConfig = {
// ... Rest of your config
compiler: {
/**
* Indicates if the compiler should be enabled.
*/
enabled: true,
/**
* Defines the output files path
*/
output: ({ fileName, extension }) => `./${fileName}${extension}`,
/**
* Indicates if the components should be saved after being transformed.
*
* - If `true`, the compiler will rewrite the component file in the disk. So the transformation will be permanent, and the compiler will skip the transformation for the next process. That way, the compiler can transform the app, and then it can be removed.
*
* - If `false`, the compiler will inject the `useIntlayer()` function call into the code in the build output only, and keep the base codebase intact. The transformation will be done only in memory.
*/
saveComponents: false,
/**
* Dictionary key prefix
*/
dictionaryKeyPrefix: "",
},
};
export default config;Run the extractor to transform your components and extract the content
Copy the code to the clipboard
npx intlayer extractDeepen Your Knowledge
If you want to learn more, you can also implement the Visual Editor or use the CMS to externalise your content.