使用您最喜欢的AI助手总结文档，并引用此页面和AI提供商
版本历史
- "更新 Solid useIntlayer API 用法以直接访问属性"v8.9.02026/5/4
- "初始历史"v8.4.102026/3/23
此页面的内容已使用 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 翻译您的 Vite 和 Lit 网站 | 国际化 (i18n)
目录
什么是 Intlayer？
Intlayer 是一个创新的开源国际化 (i18n) 库，旨在简化现代 Web 应用程序中的多语言支持。
借助 Intlayer，您可以：
- 使用组件级的声明式字典轻松管理翻译。
- 动态本地化元数据、路由和内容。
- 通过自动生成的类型确保 TypeScript 支持，提高自动补全和错误检测能力。
- 受益于高级功能，如动态语言检测和切换。
在 Vite 和 Lit 应用程序中设置 Intlayer 的分步指南
第 1 步：安装依赖项
使用 npm 安装必要的包：
复制代码到剪贴板
npm install intlayer lit-intlayernpm install vite-intlayer --save-devnpx intlayer initintlayer
lit-intlayer 将 Intlayer 与 Lit 应用程序集成的包。它提供基于
ReactiveController的钩子（useIntlayer、useLocale等），以便在语言更改时 LitElement 自动重新渲染。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 日志等。有关可用参数的完整列表，请参阅配置文档。
第 3 步：在 Vite 配置中集成 Intlayer
在您的配置中添加 intlayer 插件。
复制代码到剪贴板
import { defineConfig } from "vite";
import { intlayer } from "vite-intlayer";
// https://vitejs.dev/config/
export default defineConfig({
plugins: [intlayer()],
});intlayer() Vite 插件用于将 Intlayer 与 Vite 集成。它确保内容声明文件的构建并在开发模式下对其进行监控。它在 Vite 应用程序中定义 Intlayer 环境变量。此外，它还提供别名以优化性能。第 4 步：在入口点启动 Intlayer
在注册任何自定义元素之前调用 installIntlayer()，以便在第一个元素连接时全局语言单例已准备就绪。
复制代码到剪贴板
import { installIntlayer } from "lit-intlayer";// 必须在任何 LitElement 连接到 DOM 之前调用。installIntlayer();// 导入并注册您的自定义元素。import "./my-element.js";如果您还使用 md() 内容声明（Markdown），还要安装 Markdown 渲染器：
复制代码到剪贴板
import { installIntlayer, installIntlayerMarkdown } from "lit-intlayer";installIntlayer();installIntlayerMarkdown();import "./my-element.js";第 5 步：声明您的内容
创建并管理您的内容声明以存储翻译：
复制代码到剪贴板
import { t, type Dictionary } from "intlayer";
const appContent = {
key: "app",
content: {
title: "Vite + Lit",
viteLogo: t({
en: "Vite logo",
fr: "Logo Vite",
es: "Logo Vite",
}),
litLogo: t({
en: "Lit logo",
fr: "Logo Lit",
es: "Logo Lit",
}),
count: t({
en: "count is {{count}}",
fr: "le compte est {{count}}",
es: "el recuento es {{count}}",
}),
readTheDocs: t({
en: "Click on the Vite and Lit logos to learn more",
fr: "Cliquez sur les logos Vite et Lit pour en savoir plus",
es: "Haga clic en los logotipos de Vite y Lit para obtener más información",
}),
},
} satisfies Dictionary;
export default appContent;只要包含在
contentDir目录（默认为./src）中，且符合内容声明文件扩展名（默认为.content.{json,ts,tsx,js,jsx,mjs,cjs}），您可以在应用程序中的任何位置定义内容声明。有关更多详细信息，请参阅内容声明文档。
第 6 步：在您的 LitElement 中利用 Intlayer
在 LitElement 中使用 useIntlayer。它返回一个 ReactiveController 代理，每当激活语言发生变化时，它会自动触发重新渲染--无需额外设置。
复制代码到剪贴板
import { LitElement, html } from "lit";import { customElement, property } from "lit/decorators.js";import { useIntlayer } from "lit-intlayer";@customElement("my-element")export class MyElement extends LitElement { @property({ type: Number }) count = 0; // useIntlayer 将自身注册为 ReactiveController。 // 语言更改时，元素会自动重新渲染。 private content = useIntlayer(this, "app"); override render() { const { content } = this; return html` <h1>${content.title}</h1> <img src="/vite.svg" alt=${content.viteLogo.value} /> <img src="/lit.svg" alt=${content.litLogo.value} /> <button @click=${() => this.count++}> ${content.count({ count: this.count })} </button> <p>${content.readTheDocs}</p> `; }}当您在原生 HTML 属性（例如
alt、aria-label、title）中需要翻译后的字符串时，您可以通过多种方式使用翻译后的字符串：typescript复制代码复制代码到剪贴板
html`<img alt=${content.viteLogo.value} />`;html`<img alt=${content.viteLogo.toString()} />`;html`<img alt=${String(content.viteLogo)} />`;
（可选）第 7 步：更改内容的语言
要更改内容的语言，请使用 useLocale 控制器公开的 setLocale 方法。
复制代码到剪贴板
import { LitElement, html } from "lit";import { customElement } from "lit/decorators.js";import { getLocaleName } from "intlayer";import { useLocale } from "lit-intlayer";@customElement("locale-switcher")export class LocaleSwitcher extends LitElement { private locale = useLocale(this); private _onChange(e: Event) { const select = e.target as HTMLSelectElement; this.locale.setLocale(select.value as any); } override render() { return html` <select @change=${this._onChange}> ${this.locale.availableLocales.map( (loc) => html` <option value=${loc} ?selected=${loc === this.locale.locale}> ${getLocaleName(loc)} </option> ` )} </select> `; }}（可选）第 8 步：渲染 Markdown 和 HTML 内容
Intlayer 支持 md() 和 html() 内容声明。在 Lit 中，编译后的输出通过 unsafeHTML 指令作为原始 HTML 注入。
在您的元素中渲染编译后的 HTML：
复制代码到剪贴板
import { LitElement, html } from "lit";import { customElement } from "lit/decorators.js";import { unsafeHTML } from "lit/directives/unsafe-html.js";import { useIntlayer } from "lit-intlayer";import { compileMarkdown } from "lit-intlayer/markdown";@customElement("my-element")export class MyElement extends LitElement { private content = useIntlayer(this, "app"); override render() { return html` <div class="edit-note"> ${unsafeHTML(compileMarkdown(String(this.content.editNote)))} </div> `; }}TIP String(content.editNote)会在IntlayerNode上调用toString()，它返回原始 Markdown 字符串。将其传递给compileMarkdown以获取 HTML 字符串，然后使用 Lit 的unsafeHTML指令进行渲染。
（可选）第 9 步：为您的应用程序添加本地化路由
要为每种语言创建唯一的路线（对 SEO 很有用），您可以使用客户端路由器以及 Intlayer 的 localeMap / localeFlatMap 辅助函数，以及用于服务器端语言检测的 intlayerProxy Vite 插件。
首先，在您的 Vite 配置中添加 intlayerProxy：
请注意，要在生产环境中使用intlayerProxy，您需要将vite-intlayer从devDependencies移动到dependencies。
复制代码到剪贴板
import { defineConfig } from "vite";
import { intlayer, intlayerProxy } from "vite-intlayer";
export default defineConfig({
plugins: [
intlayerProxy(), // should be placed first
intlayer(),
],
});（可选）第 10 步：在语言更改时更改 URL
要在语言更改时更新浏览器 URL，请与语言切换器一起使用 useRewriteURL：
复制代码到剪贴板
import { LitElement, html } from "lit";import { customElement } from "lit/decorators.js";import { getLocaleName, getLocalizedUrl } from "intlayer";import { useLocale, useRewriteURL } from "lit-intlayer";@customElement("locale-switcher")export class LocaleSwitcher extends LitElement { private locale = useLocale(this); // 语言更改时自动重写当前 URL。 private _rewriteURL = useRewriteURL(this); private _onChange(e: Event) { const select = e.target as HTMLSelectElement; this.locale.setLocale(select.value as any); } override render() { return html` <select @change=${this._onChange}> ${this.locale.availableLocales.map( (loc) => html` <option value=${loc} ?selected=${loc === this.locale.locale}> ${getLocaleName(loc)} </option> ` )} </select> `; }}（可选）第 11 步：切换 HTML 语言和方向属性
更新 <html> 标签的 lang 和 dir 属性以匹配当前的语言，以提高可访问性和 SEO。
复制代码到剪贴板
import { LitElement, html } from "lit";import { customElement } from "lit/decorators.js";import { getHTMLTextDir } from "intlayer";import { useLocale } from "lit-intlayer";@customElement("my-element")export class MyElement extends LitElement { private locale = useLocale(this, { onLocaleChange: (loc) => { document.documentElement.lang = loc; document.documentElement.dir = getHTMLTextDir(loc); }, }); override render() { return html`<!-- 您的内容 -->`; }}（可选）第 12 步：提取组件的内容
如果您有现有的代码库，转换数以千计的文件可能非常耗时。
为了简化此过程，Intlayer 提供了一个编译器 / 提取器来转换您的组件并提取内容。
要进行设置，您可以尝试在 intlayer.config.ts 文件中添加 compiler 部分：
复制代码到剪贴板
import { type IntlayerConfig } from "intlayer";const config: IntlayerConfig = { // ... 配制文件的其余部分 compiler: { /** * 指示是否启用编译器。 */ enabled: true, /** * 定义输出文件路径 */ output: ({ fileName, extension }) => `./${fileName}${extension}`, /** * 指示组件在转换后是否应保存。 * 这样，编译器只需运行一次即可转换应用程序，然后就可以将其删除。 */ saveComponents: false, /** * 字典键前缀 */ dictionaryKeyPrefix: "", },};export default config;（可选）站点地图与 robots.txt（构建时生成）
Intlayer 提供 generateSitemap 与 getMultilingualUrls，可将面向爬虫的多语言 sitemap.xml 和 robots.txt 格式化并自动写入 public/。实践中在 Vite 之前运行小型 Node 脚本（例如 npm 的 predev / prebuild）即可在构建或开发时生成这些文件。
站点地图
Intlayer 的站点地图生成会尊重你的语言配置，并包含爬虫所需的元数据。
生成的站点地图支持xhtml:link（hreflang）。与只列出扁平 URL 不同，Intlayer 会在各语言版本之间建立双向关联（例如/about、/fr/about或/about?lang=fr，取决于路由模式）。
Robots.txt
使用 getMultilingualUrls，使 Disallow 覆盖敏感路径的每一种本地化写法。
1. 在项目根目录添加 generate-seo.mjs
复制代码到剪贴板
import fs from "fs";import path from "path";import { fileURLToPath } from "url";import { generateSitemap, getMultilingualUrls } from "intlayer";const __dirname = path.dirname(fileURLToPath(import.meta.url));const SITE_URL = (process.env.SITE_URL || "http://localhost:5173").replace( /\/$/, "");const pathList = [ { path: "/", changefreq: "daily", priority: 1.0 }, { path: "/about", changefreq: "monthly", priority: 0.7 },];const sitemapXml = generateSitemap(pathList, { siteUrl: SITE_URL });fs.writeFileSync(path.join(__dirname, "public", "sitemap.xml"), sitemapXml);const getAllMultilingualUrls = (urls) => urls.flatMap((url) => Object.values(getMultilingualUrls(url)));const disallowedPaths = getAllMultilingualUrls(["/admin", "/private"]);const robotsTxt = [ "User-agent: *", "Allow: /", ...disallowedPaths.map((path) => `Disallow: ${path}`), "", `Sitemap: ${SITE_URL}/sitemap.xml`,].join("\n");fs.writeFileSync(path.join(__dirname, "public", "robots.txt"), robotsTxt);console.log("SEO files generated successfully.");需已安装 intlayer 以便脚本导入。生产环境请设置环境变量 SITE_URL（例如在 CI 中）。
建议在 Node 中使用generate-seo.mjs（ESM）。若使用generate-seo.js，请在package.json中设置"type": "module"或以其他方式启用 ESM。
2. 在运行 Vite 之前执行脚本
复制代码到剪贴板
{ "scripts": { "dev": "vite", "prebuild": "node generate-seo.mjs", "build": "vite build", "preview": "vite preview" }}若使用 pnpm 或 yarn，请相应调整命令；也可在 CI 或其他步骤中调用该脚本。
配置 TypeScript
确保您的 TypeScript 配置包含自动生成的类型。
复制代码到剪贴板
{ "compilerOptions": { // ... "experimentalDecorators": true, "useDefineForClassFields": false, }, "include": ["src", ".intlayer/**/*.ts"],}Lit 的装饰器支持需要experimentalDecorators和useDefineForClassFields: false。
Git 配置
建议忽略 Intlayer 生成的文件。这可以避免将它们提交到您的 Git 仓库。
为此，您可以在 .gitignore 文件中添加以下说明：
复制代码到剪贴板
# 忽略 Intlayer 生成的文件.intlayerVS Code 扩展
为了改善您使用 Intlayer 的开发体验，您可以安装官方的 Intlayer VS Code 扩展。
此扩展提供：
- 翻译键的自动补全。
- 缺失翻译的实时错误检测。
- 翻译内容的内联预览。
- 以方便地创建和更新翻译的快速操作。
有关如何使用该扩展的更多详细信息，请参阅 Intlayer VS Code 扩展文档。