使用您最喜欢的AI助手总结文档,并引用此页面和AI提供商
版本历史
- "更新 Solid useIntlayer API 用法以直接访问属性"v8.9.02026/5/4
- "初始化历史记录"v8.4.102026/3/31
此页面的内容已使用 AI 翻译。
查看英文原文的最新版本If 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
使用 Intlayer 翻译您的 Vanilla JS 网站 | 国际化 (i18n)
目录
为什么选择 Inlayer 而不是替代品?
与“i18next”或“i18n.js”等主要解决方案相比,Intlayer是一个具有集成优化的解决方案,例如:
完整的 Vanilla JS 覆盖
Intlayer 经过优化,可与 Vanilla JavaScript 完美配合,提供与框架无关的内容管理、TypeScript 支持以及扩展国际化 (i18n) 所需的所有功能。
捆绑尺寸
不要将大量 JSON 文件加载到页面中,而只需加载必要的内容。 Intlayer 有助于将捆绑包和页面大小减少多达 50%。
可维护性
确定应用程序内容的范围有利于大型应用程序的维护。您可以复制或删除单个功能文件夹,而无需承担检查整个内容代码库的精神负担。此外,Intlayer 具有完全类型化 (fully typed),以确保您的内容的准确性。
人工智能代理
共置内容减少大型语言模型 (LLM) 所需的上下文。 Intlayer 还附带了一套工具,例如用于测试缺失翻译的 CLI、LSP、MCP 和 agent技能,使 AI 代理的开发者体验 (DX) 更加流畅。
自动化
使用您选择的法学硕士,通过自动化在 CI/CD 管道中进行翻译,而费用由您的 AI 提供商承担。 Intlayer 还提供了一个编译器来自动提取内容,以及一个网络平台来帮助在后台翻译。
表现
将大量 JSON 文件连接到组件可能会导致性能和反应性问题。 Intlayer 可在构建时 (build time)优化您的内容加载。
无需开发即可扩展
Intlayer 不仅仅是一个 i18n 解决方案,还提供了一个自托管的可视化编辑器和一个完整的 CMS 来帮助您管理多语言内容实时,与译员、文案人员和其他团队成员无缝协作。内容可以本地和/或远程存储。
Vanilla JS 应用中设置 Intlayer 的分步指南
安装依赖
使用 npm 安装必要的软件包:
bash复制代码复制代码到剪贴板
# 生成 intlayer 和 vanilla-intlayer 的独立捆绑包# 此文件将被导入到您的 HTML 文件中npx intlayer standalone --packages intlayer vanilla-intlayer --outfile intlayer.js# 使用配置文件初始化 intlayernpx intlayer init --no-gitignore# 构建字典npx intlayer buildvanilla-intlayer 将 Intlayer 与纯 JavaScript / TypeScript 应用程序集成的软件包。它提供了一个 pub/sub 单例(
IntlayerClient)和基于回调的辅助函数(useIntlayer、useLocale等),使应用的任何部分都可以响应语言区域变化,而无需依赖 UI 框架。
intlayer standaloneCLI 的捆绑导出通过树摇动未使用的软件包、语言区域和特定于您的配置的非必要逻辑(如重定向或前缀)来生成优化的构建。配置您的项目
创建一个配置文件来配置应用的语言:
intlayer.config.ts复制代码复制代码到剪贴板
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 日志等。有关可用参数的完整列表,请参考配置文档。
在您的 HTML 中导入捆绑包
生成
intlayer.js捆绑包后,可以将其导入到 HTML 文件中:index.html复制代码复制代码到剪贴板
<!DOCTYPE html><html lang="en"> <head> <meta charset="UTF-8" /> <!-- 导入捆绑包 --> <script src="./intlayer.js" defer></script> <!-- 导入您的主脚本 --> <script src="./src/main.js" defer></script> </head> <body> <h1 id="title"></h1> <p class="read-the-docs"></p> </body></html>该捆绑包在
window上将Intlayer和VanillaIntlayer暴露为全局对象。在您的入口点引导 Intlayer
在您的
src/main.js中,在渲染任何内容之前调用installIntlayer(),以便全局语言区域单例已准备就绪。src/main.js复制代码复制代码到剪贴板
const { installIntlayer } = window.VanillaIntlayer;// 必须在渲染任何 i18n 内容之前调用。installIntlayer();如果您还想使用 markdown 渲染器,请调用
installIntlayerMarkdown():src/main.js复制代码复制代码到剪贴板
const { installIntlayer, installIntlayerMarkdown } = window.VanillaIntlayer;installIntlayer();installIntlayerMarkdown();声明您的内容
创建和管理您的内容声明以存储翻译:
src/app.content.ts复制代码复制代码到剪贴板
import { insert, t, type Dictionary } from "intlayer"; const appContent = { key: "app", content: { title: "Vite + Vanilla", viteLogoLabel: t({ zh: "Vite Logo", en: "Vite Logo", fr: "Logo Vite", es: "Logo Vite", }), count: insert( t({ zh: "计数为 {{count}}", en: "count is {{count}}", fr: "le compte est {{count}}", es: "el recuento es {{count}}", }) ), readTheDocs: t({ zh: "单击 Vite 徽标以了解更多信息", en: "Click on the Vite logo to learn more", fr: "Cliquez sur le logo Vite pour en savoir plus", es: "Haga clic en el logotipo de Vite para obtener más información", }), }, } satisfies Dictionary; export default appContent;您的内容声明可以在应用的任何位置定义,只要它们包含在
contentDir目录中(默认为./src),并与内容声明文件扩展名匹配(默认为.content.{json,ts,tsx,js,jsx,mjs,cjs,md,mdx,yaml,yml})。有关更多详细信息,请参考内容声明文档。
在您的 JavaScript 中使用 Intlayer
window.VanillaIntlayer对象提供 API 辅助函数:useIntlayer(key, locale?)返回给定键的已翻译内容。src/main.js复制代码复制代码到剪贴板
const { installIntlayer, useIntlayer } = window.VanillaIntlayer;installIntlayer();// 获取当前语言区域的初始内容。// 链接 .onChange() 以在语言区域更改时获得通知。const content = useIntlayer("app").onChange((newContent) => { // 仅重新渲染或修补受影响的 DOM 节点 document.querySelector("h1").textContent = String(newContent.title); document.querySelector(".read-the-docs").textContent = String( newContent.readTheDocs );});// 初始渲染document.querySelector("h1").textContent = String(content.title);document.querySelector(".read-the-docs").textContent = String( content.readTheDocs);通过将叶值包装在
String()中来以字符串形式访问它们,该函数调用节点的toString()方法并返回翻译的文本。当您需要用于原生 HTML 属性(例如
alt、aria-label)的值时,直接使用.value:javascript复制代码复制代码到剪贴板
img.alt = content.viteLogoLabel.value;更改您的内容的语言
可选要更改您的内容的语言,请使用由
useLocale暴露的setLocale函数。src/locale-switcher.js复制代码复制代码到剪贴板
const { getLocaleName } = window.Intlayer;const { useLocale } = window.VanillaIntlayer;export function setupLocaleSwitcher(container) { const { locale, availableLocales, setLocale, subscribe } = useLocale(); const select = document.createElement("select"); select.setAttribute("aria-label", "Language"); const render = (currentLocale) => { select.innerHTML = availableLocales .map( (loc) => `<option value="${loc}"${loc === currentLocale ? " selected" : ""}> ${getLocaleName(loc)} </option>` ) .join(""); }; render(locale); container.appendChild(select); select.addEventListener("change", () => setLocale(select.value)); // 保持下拉列表与从其他位置更改的语言区域同步 return subscribe((newLocale) => render(newLocale));}切换 HTML 语言和方向属性
可选更新
<html>标签的lang和dir属性以匹配当前语言区域,以实现无障碍访问和 SEO。src/main.js复制代码复制代码到剪贴板
const { getHTMLTextDir } = window.Intlayer;const { installIntlayer, useLocale } = window.VanillaIntlayer;installIntlayer();useLocale({ onLocaleChange: (locale) => { document.documentElement.lang = locale; document.documentElement.dir = getHTMLTextDir(locale); },});按语言区域懒加载字典
可选如果您想按语言区域懒加载字典,可以使用
useDictionaryDynamic。这在您不想将所有翻译捆绑在初始intlayer.js文件中时很有用。src/app.js复制代码复制代码到剪贴板
const { installIntlayer, useDictionaryDynamic } = window.VanillaIntlayer;installIntlayer();const unsubscribe = useDictionaryDynamic( { en: () => import("../.intlayer/dictionaries/en/app.mjs"), fr: () => import("../.intlayer/dictionaries/fr/app.mjs"), es: () => import("../.intlayer/dictionaries/es/app.mjs"), }, "app").onChange((content) => { document.querySelector("h1").textContent = String(content.title);});注意:
useDictionaryDynamic要求字典作为单独的 ESM 文件可用。如果您有一个 Web 服务器提供字典,通常会使用此方法。
配置 TypeScript
确保您的 TypeScript 配置包含自动生成的类型。
复制代码到剪贴板
{ "compilerOptions": { // ... }, "include": ["src", ".intlayer/**/*.ts"],}VS Code 扩展
为了提升使用 Intlayer 的开发体验,您可以安装官方的 Intlayer VS Code 扩展。
该扩展提供:
- 翻译键的自动补全。
- 缺失翻译的实时错误检测。
- 翻译内容的内联预览。
- 轻松创建和更新翻译的快速操作。
有关如何使用该扩展的更多详细信息,请参阅 Intlayer VS Code 扩展文档。