使用您最喜欢的AI助手总结文档,并引用此页面和AI提供商
通过将 Intlayer MCP 服务器集成到您的 AI 助手,您可以直接从 ChatGPT、DeepSeek、Cursor、VSCode 等获取所有文档。
查看 MCP 服务器文档此页面的内容已使用 AI 翻译。
查看英文原文的最新版本如果您有改善此文档的想法,请随时通过在GitHub上提交拉取请求来贡献。
文档的 GitHub 链接复制文档 Markdown 到剪贴板
使用 Intlayer 和 Vite 及 Vue 开始国际化(i18n)
请参阅 GitHub 上的应用模板。
什么是 Intlayer?
Intlayer 是一个创新的开源国际化(i18n)库,旨在简化现代 Web 应用中的多语言支持。
使用 Intlayer,您可以:
- 通过组件级声明式字典轻松管理翻译。
- 动态本地化元数据、路由和内容。
- 确保 TypeScript 支持,通过自动生成类型,提升自动补全和错误检测能力。
- 享受高级功能,如动态语言环境检测和切换。
在 Vite 和 Vue 应用中设置 Intlayer 的分步指南
第一步:安装依赖
使用 npm 安装所需的包:
复制代码到剪贴板
npm install intlayer vue-intlayernpm install vite-intlayer --save-dev
intlayer
vue-intlayer 将 Intlayer 集成到 Vue 应用中的包,提供 Vue 国际化的上下文提供者和组合式函数。
vite-intlayer 包含用于将 Intlayer 集成到 Vite 打包工具 的 Vite 插件,以及用于检测用户首选语言环境、管理 Cookie 和处理 URL 重定向的中间件。
第 2 步:配置您的项目
创建一个配置文件来配置应用程序的语言:
复制代码到剪贴板
import { Locales, type IntlayerConfig } from "intlayer";const config: IntlayerConfig = { internationalization: { locales: [ Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH, // 您的其他语言环境 ], defaultLocale: Locales.ENGLISH, },};export default config;
通过此配置文件,您可以设置本地化的 URL、中间件重定向、cookie 名称、内容声明的位置和扩展名,禁用控制台中的 Intlayer 日志等。有关可用参数的完整列表,请参阅配置文档。
第三步:在您的 Vite 配置中集成 Intlayer
将 intlayer 插件添加到您的配置中。
复制代码到剪贴板
import { defineConfig } from "vite";import vue from "@vitejs/plugin-vue";import { intlayerPlugin } from "vite-intlayer";// https://vitejs.dev/config/export default defineConfig({ plugins: [vue(), intlayerPlugin()],});
intlayerPlugin() Vite 插件用于将 Intlayer 集成到 Vite 中。它确保构建内容声明文件并在开发模式下监视这些文件。在 Vite 应用中定义了 Intlayer 环境变量。此外,它还提供别名以优化性能。
第4步:声明您的内容
创建并管理您的内容声明以存储翻译:
复制代码到剪贴板
import { t, type Dictionary } from "intlayer";const helloWorldContent = { key: "helloworld", content: { count: t({ en: "count is ", fr: "le compte est ", es: "el recuento es " }), edit: t({ en: "Edit <code>components/HelloWorld.vue</code> and save to test HMR", fr: "Éditez <code>components/HelloWorld.vue</code> et enregistrez pour tester HMR", es: "Edita <code>components/HelloWorld.vue</code> y guarda para probar HMR", }), checkOut: t({ en: "Check out ", fr: "Vérifiez ", es: "Compruebe " }), officialStarter: t({ en: ", the official Vue + Vite starter", fr: ", le starter officiel Vue + Vite", es: ", el starter oficial Vue + Vite", }), learnMore: t({ zh: "了解更多关于 Vue 的 IDE 支持,详见 ", en: "Learn more about IDE Support for Vue in the ", fr: "En savoir plus sur le support IDE pour Vue dans le ", es: "Aprenda más sobre el soporte IDE para Vue en el ", }), vueDocs: t({ zh: "Vue 文档扩展指南", en: "Vue Docs Scaling up Guide", fr: "Vue Docs Scaling up Guide", es: "Vue Docs Scaling up Guide", }), readTheDocs: t({ en: "Click on the Vite and Vue logos to learn more", fr: "Cliquez sur les logos Vite et Vue pour en savoir plus", es: "Haga clic en los logotipos de Vite y Vue para obtener más información", zh: "点击 Vite 和 Vue 标志以了解更多信息", }), },} satisfies Dictionary;export default helloWorldContent;
您的内容声明可以定义在应用程序中的任何位置,只要它们被包含在 contentDir 目录中(默认是 ./src)。并且文件扩展名需匹配内容声明的文件扩展名(默认是 .content.{json,ts,tsx,js,jsx,mjs,mjx,cjs,cjx})。
更多详情,请参阅内容声明文档。
第5步:在代码中使用 Intlayer
要在整个 Vue 应用中使用 Intlayer 的国际化功能,首先需要在主文件中注册 Intlayer 单例实例。这一步非常关键,因为它为应用中的所有组件提供了国际化上下文,使得翻译内容可以在组件树中的任何位置访问。
复制代码到剪贴板
import { createApp } from "vue";import { installIntlayer } from "vue-intlayer";import App from "./App.vue";import "./style.css";const app = createApp(App);// 在顶层注入提供者installIntlayer(app);// 挂载应用app.mount("#app");
通过创建主 Vue 组件并使用 useIntlayer 组合函数,可以在整个应用中访问内容字典:
复制代码到剪贴板
<script setup lang="ts">import { ref } from "vue";import { useIntlayer } from "vue-intlayer";defineProps({ msg: String,});const { count, edit, checkOut, officialStarter, learnMore, vueDocs, readTheDocs,} = useIntlayer("helloworld");const countRef = ref(0);</script><template> <h1>{{ msg }}</h1> <div class="card"> <button type="button" @click="countRef++"> <count /> {{ countRef }} </button> <p v-html="edit"></p> </div> <p> <checkOut /> <a href="https://vuejs.org/guide/quick-start.html#local" target="_blank" >create-vue</a >,<officialStarter /> </p> <p> <learnMore /> <a href="https://vuejs.org/guide/scaling-up/tooling.html#ide-support" target="_blank" ><vueDocs /></a >. </p> <p class="read-the-docs"><readTheDocs /></p> <p class="read-the-docs">{{ readTheDocs }}</p></template>
在 Intlayer 中访问内容
Intlayer 提供了多种 API 来访问您的内容:
基于组件的语法(推荐): 使用 <myContent /> 或 <Component :is="myContent" /> 语法将内容渲染为 Intlayer 节点。这与可视化编辑器和内容管理系统无缝集成。
基于字符串的语法: 使用 {{ myContent }} 将内容渲染为纯文本,不支持可视化编辑器。
原始 HTML 语法: 使用 <div v-html="myContent" /> 来渲染内容为原始 HTML,不支持可视化编辑器。
解构语法: useIntlayer 组合函数返回一个包含内容的 Proxy。该 Proxy 可以被解构以访问内容,同时保持响应性。
- 使用 const content = useIntlayer("myContent"); 并通过 {{ content.myContent }} / <content.myContent /> 访问内容。
- 或者使用 const { myContent } = useIntlayer("myContent"); 并通过 {{ myContent }} / <myContent/> 解构访问内容。
(可选)步骤 6:更改内容语言
要更改内容的语言,可以使用 useLocale 组合函数提供的 setLocale 函数。该函数允许你设置应用的语言环境,并相应地更新内容。
创建一个组件以切换语言:
复制代码到剪贴板
<template> <div class="locale-switcher"> <select v-model="selectedLocale" @change="changeLocale"> <option v-for="loc in availableLocales" :key="loc" :value="loc"> {{ getLocaleName(loc) }} </option> </select> </div></template><script setup lang="ts">import { ref, watch } from "vue";import { getLocaleName } from "intlayer";import { useLocale } from "vue-intlayer";// 获取语言信息和 setLocale 函数const { locale, availableLocales, setLocale } = useLocale();// 使用 ref 跟踪选中的语言const selectedLocale = ref(locale.value);// 当选择更改时更新语言const changeLocale = () => setLocale(selectedLocale.value);// 保持 selectedLocale 与全局 locale 同步watch( () => locale.value, (newLocale) => { selectedLocale.value = newLocale; });</script>
然后,在你的 App.vue 中使用该组件:
复制代码到剪贴板
<script setup lang="ts">import { useIntlayer } from "vue-intlayer";import HelloWorld from "@components/HelloWorld.vue";import LocaleSwitcher from "@components/LocaleSwitcher.vue";import { ref, watch } from "vue";const content = useIntlayer("app"); // 创建相关的 intlayer 声明文件</script><template> <div> <LocaleSwitcher /> <a href="https://vite.dev" target="_blank"> <img src="/vite.svg" class="logo" :alt="content.viteLogo" /> </a> <a href="https://vuejs.org/" target="_blank"> <img src="./assets/vue.svg" class="logo vue" :alt="content.vueLogo" /> </a> </div> <HelloWorld :msg="content.title" /></template>
(可选)步骤7:为您的应用添加本地化路由
在 Vue 应用中添加本地化路由通常涉及使用带有语言前缀的 Vue Router。这为每种语言创建唯一的路由,有助于 SEO 和 SEO 友好的 URL。
示例:
复制代码到剪贴板
- https://example.com/about- https://example.com/es/about- https://example.com/fr/about
首先,安装 Vue Router:
复制代码到剪贴板
npm install intlayer vue-router
然后,创建一个处理基于语言环境路由的路由配置:
复制代码到剪贴板
import { configuration, getPathWithoutLocale, localeFlatMap, type Locales,} from 'intlayer';import { createIntlayerClient } from 'vue-intlayer';import { createRouter, createWebHistory } from 'vue-router';import HomeView from './views/home/HomeView.vue';import RootView from './views/root/Root.vue';// 获取国际化配置const { internationalization, middleware } = configuration;const { defaultLocale } = internationalization;/** * 声明带有语言环境特定路径和元数据的路由。 */const routes = localeFlatMap((localizedData) => [ { path: `${localizedData.urlPrefix}/`, name: `Root-${localizedData.locale}`, component: RootView, meta: { locale: localizedData.locale, }, }, { path: `${localizedData.urlPrefix}/home`, name: `Home-${localizedData.locale}`, component: HomeView, meta: { locale: localizedData.locale, }, },]);// 创建路由实例export const router = createRouter({ history: createWebHistory(), routes,});// 添加导航守卫以处理语言环境router.beforeEach((to, _from, next) => { const client = createIntlayerClient(); const metaLocale = to.meta.locale as Locales | undefined; if (metaLocale) { // 重用路由元信息中定义的语言环境 client.setLocale(metaLocale); next(); } else { // 回退:元信息中没有语言环境,可能是未匹配的路由 // 可选:处理 404 或重定向到默认语言环境 client.setLocale(defaultLocale); if (middleware.prefixDefault) { next(`/${defaultLocale}${getPathWithoutLocale(to.path)}`); } else { next(getPathWithoutLocale(to.path)); } }});
名称用于在路由器中识别路由。它应在所有路由中唯一,以避免冲突并确保正确的导航和链接。
然后,在你的 main.js 文件中注册路由器:
复制代码到剪贴板
import { createApp } from "vue";import App from "./App.vue";import { router } from "./router";import "./style.css";const app = createApp(App);// 将路由器添加到应用中app.use(router);// 挂载应用app.mount("#app");
然后更新你的 App.vue 文件以渲染 RouterView 组件。该组件将显示当前路由匹配的组件。
复制代码到剪贴板
<script setup lang="ts">import LocaleSwitcher from "@components/LocaleSwitcher.vue";</script><template> <nav> <LocaleSwitcher /> </nav> <RouterView /></template>
同时,你也可以使用 intlayerMiddlewarePlugin 为你的应用添加服务器端路由。该插件会根据 URL 自动检测当前语言环境并设置相应的语言环境 cookie。如果未指定语言环境,插件将根据用户浏览器的语言偏好确定最合适的语言环境。如果仍未检测到语言环境,则会重定向到默认语言环境。
复制代码到剪贴板
import { defineConfig } from "vite";import vue from "@vitejs/plugin-vue";import { intlayerPlugin, intlayerMiddlewarePlugin } from "vite-intlayer";// https://vitejs.dev/config/export default defineConfig({ plugins: [vue(), intlayerPlugin(), intlayerMiddlewarePlugin()],});
(可选)步骤 8:当语言环境变化时更改 URL
为了在用户更改语言时自动更新 URL,您可以修改 LocaleSwitcher 组件以使用 Vue Router:
复制代码到剪贴板
<template> <div class="locale-switcher"> <select v-model="selectedLocale" @change="changeLocale"> <option v-for="loc in availableLocales" :key="loc" :value="loc"> {{ getLocaleName(loc) }} </option> </select> </div></template><script setup lang="ts">import { ref, watch } from "vue";import { useRouter } from "vue-router";import { Locales, getLocaleName, getLocalizedUrl } from "intlayer";import { useLocale } from "vue-intlayer";// 获取 Vue Router 实例const router = useRouter();// 获取语言信息和设置语言的函数const { locale, availableLocales, setLocale } = useLocale({ onLocaleChange: (newLocale) => { // 获取当前路由并创建本地化的 URL const currentPath = router.currentRoute.value.fullPath; const localizedPath = getLocalizedUrl(currentPath, newLocale); // 导航到本地化路由而不重新加载页面 router.push(localizedPath); },});// 使用 ref 跟踪选中的语言const selectedLocale = ref(locale.value);// 当选择更改时更新语言环境const changeLocale = () => { setLocale(selectedLocale.value);};// 保持 selectedLocale 与全局语言环境同步watch( () => locale.value, (newLocale) => { selectedLocale.value = newLocale; });</script>
提示:为了更好的 SEO 和可访问性,使用如 <a href="/fr/home" hreflang="fr"> 这样的标签来链接到本地化页面,如步骤10所示。这允许搜索引擎正确发现和索引特定语言的 URL。为了保持 SPA 行为,可以通过 @click.prevent 阻止默认导航,使用 useLocale 更改语言环境,并通过 Vue Router 编程式导航。
复制代码到剪贴板
<ol class="divide-text/20 divide-y divide-dashed overflow-y-auto p-1"> <li> <a hreflang="x-default" aria-label="切换到英语" target="_self" aria-current="page" href="/doc/get-started" > <div> <span dir="ltr" lang="en">English</span> <span>英语</span> <span>EN</span> </div> </a> </li> <li> <a hreflang="es" aria-label="切换到西班牙语" target="_self" href="/es/doc/get-started" > <div> <span dir="ltr" lang="es">Español</span> <span>西班牙语</span> <span>ES</span> </div> </a> </li></ol>
(可选)步骤9:切换HTML的语言和方向属性
当您的应用支持多种语言时,更新<html>标签的lang和dir属性以匹配当前语言环境至关重要。这样做可以确保:
- 无障碍访问:屏幕阅读器和辅助技术依赖正确的 lang 属性来准确发音和解释内容。
- 文本渲染:dir(方向)属性确保文本以正确的顺序呈现(例如,英语为从左到右,阿拉伯语或希伯来语为从右到左),这对于可读性至关重要。
- 搜索引擎优化(SEO):搜索引擎使用 lang 属性来确定页面的语言,有助于在搜索结果中提供正确的本地化内容。
通过在语言环境变化时动态更新这些属性,您可以确保所有支持语言的用户都获得一致且无障碍的体验。
复制代码到剪贴板
import { watch } from "vue";import { useLocale } from "vue-intlayer";import { getHTMLTextDir } from "intlayer";/** * 组合函数,根据当前语言环境更新 HTML <html> 元素的 `lang` 和 `dir` 属性。 * * @example * // 在你的 App.vue 或全局组件中 * import { useI18nHTMLAttributes } from './composables/useI18nHTMLAttributes' * * useI18nHTMLAttributes() */export const useI18nHTMLAttributes = () => { const { locale } = useLocale(); // 每当语言环境变化时更新 HTML 属性 watch( () => locale.value, (newLocale) => { if (!newLocale) return; // 更新语言属性 document.documentElement.lang = newLocale; // 设置文本方向(大多数语言为从左到右,阿拉伯语、希伯来语等为从右到左) document.documentElement.dir = getHTMLTextDir(newLocale); }, { immediate: true } );};
在你的 App.vue 或全局组件中使用此组合函数:
复制代码到剪贴板
<script setup lang="ts">import { useI18nHTMLAttributes } from "@composables/useI18nHTMLAttributes";// 根据当前语言环境应用 HTML 属性useI18nHTMLAttributes();</script><template> <!-- 你的应用模板 --></template>
(可选)步骤 10:创建本地化链接组件
为了确保您的应用程序导航遵循当前的语言环境,您可以创建一个自定义的 Link 组件。该组件会自动在内部 URL 前添加当前语言的前缀。例如,当讲法语的用户点击“关于”页面的链接时,他们会被重定向到 /fr/about,而不是 /about。
这种行为有几个好处:
- SEO 和用户体验:本地化的 URL 有助于搜索引擎正确索引特定语言的页面,并为用户提供其偏好的语言内容。
- 一致性:通过在整个应用中使用本地化链接,您可以确保导航保持在当前语言环境内,避免意外的语言切换。
- 可维护性:将本地化逻辑集中在单个组件中简化了 URL 的管理,使您的代码库更易于维护和扩展,随着应用程序的增长。
复制代码到剪贴板
<template> <a :href="localizedHref" v-bind="$attrs"> <slot /> </a></template><script setup lang="ts">import { computed } from "vue";import { getLocalizedUrl } from "intlayer";import { useLocale } from "vue-intlayer";const props = defineProps({ href: { type: String, required: true, },});const { locale } = useLocale();// 检查链接是否为外部链接const isExternalLink = computed(() => /^https?:\/\//.test(props.href || ""));// 为内部链接创建本地化的 hrefconst localizedHref = computed(() => isExternalLink.value ? props.href : getLocalizedUrl(props.href, locale.value));</script>
用于 Vue Router,创建一个路由专用版本:
复制代码到剪贴板
<template> <router-link :to="localizedTo" v-bind="$attrs"> <slot /> </router-link></template><script setup lang="ts">import { computed } from "vue";import { getLocalizedUrl } from "intlayer";import { useLocale } from "vue-intlayer";const props = defineProps({ to: { type: [String, Object], required: true, },});const { locale } = useLocale();// 为 router-link 创建本地化的 to 属性const localizedTo = computed(() => { if (typeof props.to === "string") { return getLocalizedUrl(props.to, locale.value); } else { // 如果 'to' 是一个对象,则本地化 path 属性 return { ...props.to, path: getLocalizedUrl(props.to.path ?? "/", locale.value), }; }});</script>
在您的应用程序中使用这些组件:
复制代码到剪贴板
<template> <div> <!-- Vue 路由 --> <RouterLink to="/">根目录</RouterLink> <RouterLink to="/home">首页</RouterLink> <!-- 其他 --> <Link href="/">根目录</Link> <Link href="/home">首页</Link> </div></template><script setup lang="ts">import Link from "@components/Link.vue";import RouterLink from "@components/RouterLink.vue";</script>
(可选)步骤 11:渲染 Markdown
Intlayer 支持在您的 Vue 应用中直接渲染 Markdown 内容。默认情况下,Markdown 被视为纯文本。要将 Markdown 转换为丰富的 HTML,您可以集成一个 Markdown 解析器 markdown-it。
当您的翻译内容包含格式化内容,如列表、链接或强调时,这尤其有用。
默认情况下,Intlayer 将 Markdown 渲染为字符串。但 Intlayer 也提供了一种使用 installIntlayerMarkdown 函数将 Markdown 渲染为 HTML 的方式。
要了解如何使用 intlayer 包声明 Markdown 内容,请参见 markdown 文档。
复制代码到剪贴板
import MarkdownIt from "markdown-it";import { createApp, h } from "vue";import { installIntlayer, installIntlayerMarkdown } from "vue-intlayer";const app = createApp(App);installIntlayer(app);const md = new MarkdownIt({ html: true, // 允许 HTML 标签 linkify: true, // 自动识别链接 typographer: true, // 启用智能引号、破折号等排版功能});// 告诉 Intlayer 在需要将 markdown 转换为 HTML 时使用 md.render()installIntlayerMarkdown(app, (markdown) => { const html = md.render(markdown); return h("div", { innerHTML: html });});
注册完成后,您可以使用基于组件的语法直接显示 Markdown 内容:
复制代码到剪贴板
<template> <div> <myMarkdownContent /> </div></template><script setup lang="ts">import { useIntlayer } from "vue-intlayer";const { myMarkdownContent } = useIntlayer("my-component");</script>
配置 TypeScript
Intlayer 使用模块增强来利用 TypeScript 的优势,使您的代码库更强大。
确保您的 TypeScript 配置包含自动生成的类型。
复制代码到剪贴板
{ // ... 您现有的 TypeScript 配置 "include": [ // ... 您现有的 TypeScript 配置 ".intlayer/**/*.ts", // 包含自动生成的类型 ],}
Git 配置
建议忽略 Intlayer 生成的文件。这样可以避免将它们提交到您的 Git 仓库中。
为此,您可以在 .gitignore 文件中添加以下指令:
复制代码到剪贴板
# 忽略 Intlayer 生成的文件.intlayer
VS Code 扩展
为了提升您使用 Intlayer 的开发体验,您可以安装官方的 Intlayer VS Code 扩展。
该扩展提供:
- 翻译键的 自动补全。
- 缺失翻译的 实时错误检测。
- 翻译内容的 内联预览。
- 轻松创建和更新翻译的 快速操作。
建议忽略由 Intlayer 生成的文件。这样可以避免将它们提交到您的 Git 仓库中。
为此,您可以在 .gitignore 文件中添加以下指令:
复制代码到剪贴板
# 忽略由 Intlayer 生成的文件.intlayer
VS Code 扩展
为了提升您使用 Intlayer 的开发体验,您可以安装官方的 Intlayer VS Code 扩展。
该扩展提供:
- 翻译键的 自动补全。
- 缺失翻译的 实时错误检测。
- 翻译内容的 内联预览。
- 轻松创建和更新翻译的 快速操作。
有关如何使用该扩展的更多详细信息,请参阅 Intlayer VS Code 扩展文档。
深入了解
要进一步使用,您可以实现 可视化编辑器 或使用 CMS 来外部管理您的内容。
文档历史
- 5.5.10 - 2025-06-29: 初始化历史记录