使用您最喜欢的AI助手总结文档,并引用此页面和AI提供商
通过将 Intlayer MCP 服务器集成到您的 AI 助手,您可以直接从 ChatGPT、DeepSeek、Cursor、VSCode 等获取所有文档。
查看 MCP 服务器文档此页面的内容已使用 AI 翻译。
查看英文原文的最新版本如果您有改善此文档的想法,请随时通过在GitHub上提交拉取请求来贡献。
文档的 GitHub 链接复制文档 Markdown 到剪贴板
在 Vite 和 React 应用中设置 Intlayer 的分步指南
第一步:安装依赖
使用 npm 安装所需的包:
复制代码到剪贴板
npm install intlayer react-intlayernpm install vite-intlayer --save-dev
intlayer
react-intlayer 将 Intlayer 集成到 React 应用中的包。它提供了用于 React 国际化的上下文提供者和钩子。
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 react from "@vitejs/plugin-react-swc";import { intlayerPlugin } from "vite-intlayer";// https://vitejs.dev/config/export default defineConfig({ plugins: [react(), intlayerPlugin()],});
intlayerPlugin() Vite 插件用于将 Intlayer 集成到 Vite 中。它确保内容声明文件的构建,并在开发模式下监视这些文件。在 Vite 应用程序中定义了 Intlayer 环境变量。此外,它还提供别名以优化性能。
第4步:声明您的内容
创建并管理您的内容声明以存储翻译:
复制代码到剪贴板
import { t, type Dictionary } from "intlayer";import type { ReactNode } from "react";const appContent = { key: "app", content: { viteLogo: t({ en: "Vite logo", fr: "Logo Vite", es: "Logo Vite", }), reactLogo: t({ en: "React logo", fr: "Logo React", es: "Logo React", }), title: "Vite + React", count: t({ en: "count is ", fr: "le compte est ", es: "el recuento es ", }), edit: t<ReactNode>({ en: ( <> 编辑 <code>src/App.tsx</code> 并保存以测试 HMR </> ), fr: ( <> Éditez <code>src/App.tsx</code> et enregistrez pour tester HMR </> ), es: ( <> Edita <code>src/App.tsx</code> y guarda para probar HMR </> ), }), readTheDocs: t({ en: "点击 Vite 和 React 标志以了解更多信息", fr: "Cliquez sur les logos Vite et React pour en savoir plus", es: "Haga clic en los logotipos de Vite y React para obtener más información", }), },} 满足 Dictionary;export default appContent;
您的内容声明可以定义在应用程序中的任何位置,只要它们被包含在 contentDir 目录中(默认是 ./src)。并且匹配内容声明文件的扩展名(默认是 .content.{json,ts,tsx,js,jsx,mjs,mjx,cjs,cjx})。
更多详情,请参阅内容声明文档。
如果您的内容文件包含 TSX 代码,您应考虑在内容文件中导入 import React from "react";。
第5步:在代码中使用 Intlayer
在整个应用程序中访问您的内容字典:
复制代码到剪贴板
import { useState, type FC } from "react";import reactLogo from "./assets/react.svg";import viteLogo from "/vite.svg";import "./App.css";import { IntlayerProvider, useIntlayer } from "react-intlayer";const AppContent: FC = () => { const [count, setCount] = useState(0); const content = useIntlayer("app"); return ( <> <div> <a href="https://vitejs.dev" target="_blank"> <img src={viteLogo} className="logo" alt={content.viteLogo.value} /> </a> <a href="https://react.dev" target="_blank"> <img src={reactLogo} className="logo react" alt={content.reactLogo.value} /> </a> </div> <h1>{content.title}</h1> <div className="card"> <button onClick={() => setCount((count) => count + 1)}> {content.count} {count} </button> <p>{content.edit}</p> </div> <p className="read-the-docs">{content.readTheDocs}</p> </> );};const App: FC = () => ( <IntlayerProvider> <AppContent /> </IntlayerProvider>);export default App;
如果您想在字符串属性中使用内容,例如 alt、title、href、aria-label 等,必须调用函数的值,如下所示:
jsx复制代码复制代码到剪贴板
<img src={content.image.src.value} alt={content.image.value} />
要了解有关 useIntlayer 钩子的更多信息,请参阅文档。
(可选)步骤 6:更改内容的语言
要更改内容的语言,可以使用 useLocale 钩子提供的 setLocale 函数。该函数允许您设置应用程序的语言环境并相应地更新内容。
复制代码到剪贴板
import type { FC } from "react";import { Locales } from "intlayer";import { useLocale } from "react-intlayer";const LocaleSwitcher: FC = () => { const { setLocale } = useLocale(); return ( <button onClick={() => setLocale(Locales.English)}>切换语言到英语</button> );};
要了解有关 useLocale 钩子的更多信息,请参阅文档。
(可选)步骤 7:为您的应用程序添加本地化路由
此步骤的目的是为每种语言创建唯一的路由。这对于 SEO 和 SEO 友好的 URL 非常有用。 示例:
复制代码到剪贴板
- https://example.com/about- https://example.com/es/about- https://example.com/fr/about
默认情况下,默认语言的路由不会添加前缀。如果您想为默认语言添加前缀,可以在配置中将 middleware.prefixDefault 选项设置为 true。更多信息请参见配置文档。
要为您的应用添加本地化路由,您可以创建一个 LocaleRouter 组件,包裹应用的路由并处理基于语言的路由。以下是使用 React Router 的示例:
复制代码到剪贴板
// 导入必要的依赖和函数import { type Locales, configuration, getPathWithoutLocale } from "intlayer"; // 来自 'intlayer' 的实用函数和类型import type { FC, PropsWithChildren } from "react"; // React 中函数组件和属性的类型import { IntlayerProvider } from "react-intlayer"; // 国际化上下文提供者import { BrowserRouter, Routes, Route, Navigate, useLocation,} from "react-router-dom"; // 用于管理导航的路由组件// 从 Intlayer 中解构配置const { internationalization, middleware } = configuration;const { locales, defaultLocale } = internationalization;/** * 一个处理本地化的组件,使用适当的语言环境上下文包裹子组件。 * 它管理基于 URL 的语言环境检测和验证。 */const AppLocalized: FC<PropsWithChildren<{ locale: Locales }>> = ({ children, locale,}) => { const { pathname, search } = useLocation(); // 获取当前的URL路径 // 确定当前的语言环境,如果未提供则回退到默认语言环境 const currentLocale = locale ?? defaultLocale; // 移除路径中的语言环境前缀以构建基础路径 const pathWithoutLocale = getPathWithoutLocale( pathname // 当前的URL路径 ); /** * 如果 middleware.prefixDefault 为 true,则默认语言环境应始终带有前缀。 */ if (middleware.prefixDefault) { // 验证语言环境 if (!locale || !locales.includes(locale)) { // 重定向到带有更新路径的默认语言环境 return ( <Navigate to={`/${defaultLocale}/${pathWithoutLocale}${search}`} replace // 替换当前的历史记录条目为新的条目 /> ); } // 使用 IntlayerProvider 包裹子组件并设置当前语言环境 return ( <IntlayerProvider locale={currentLocale}>{children}</IntlayerProvider> ); } else { /** * 当 middleware.prefixDefault 为 false 时,默认语言环境不带前缀。 * 确保当前语言环境有效且不是默认语言环境。 */ if ( currentLocale.toString() !== defaultLocale.toString() && !locales .filter( (locale) => locale.toString() !== defaultLocale.toString() // 排除默认语言环境 ) .includes(currentLocale) // 检查当前语言环境是否在有效语言列表中 ) { // 重定向到无语言前缀的路径 return <Navigate to={`${pathWithoutLocale}${search}`} replace />; } // 使用 IntlayerProvider 包裹子组件并设置当前语言环境 return ( <IntlayerProvider locale={currentLocale}>{children}</IntlayerProvider> ); }};/** * 一个设置特定语言路由的路由组件。 * 它使用 React Router 来管理导航并渲染本地化组件。 */export const LocaleRouter: FC<PropsWithChildren> = ({ children }) => ( <BrowserRouter> <Routes> {locales .filter( (locale) => middleware.prefixDefault || locale !== defaultLocale ) .map((locale) => ( <Route // 路由模式用于捕获语言环境(例如 /en/,/fr/)并匹配所有后续路径 path={`/${locale}/*`} key={locale} element={<AppLocalized locale={locale}>{children}</AppLocalized>} // 使用语言环境管理包装子组件 /> ))} { // 如果禁用默认语言环境前缀,则直接在根路径渲染子组件 !middleware.prefixDefault && ( <Route path="*" element={ <AppLocalized locale={defaultLocale}>{children}</AppLocalized> } // 使用语言环境管理包装子组件 /> ) } </Routes> </BrowserRouter>);
然后,您可以在应用中使用 LocaleRouter 组件:
复制代码到剪贴板
import { LocaleRouter } from "./components/LocaleRouter";import type { FC } from "react";// ... 你的 AppContent 组件const App: FC = () => ( <LocaleRouter> <AppContent /> </LocaleRouter>);
同时,您还可以使用 intLayerMiddlewarePlugin 为您的应用程序添加服务器端路由。该插件将根据 URL 自动检测当前语言环境并设置相应的语言环境 Cookie。如果未指定语言环境,插件将根据用户浏览器的语言偏好确定最合适的语言环境。如果未检测到任何语言环境,它将重定向到默认语言环境。
复制代码到剪贴板
import { defineConfig } from "vite";import react from "@vitejs/plugin-react-swc";import { intlayerPlugin, intLayerMiddlewarePlugin } from "vite-intlayer";// https://vitejs.dev/config/export default defineConfig({ plugins: [react(), intlayerPlugin(), intLayerMiddlewarePlugin()],});
(可选)步骤 8:在语言切换时更改 URL
要在语言切换时更改 URL,可以使用 useLocale 钩子提供的 onLocaleChange 属性。同时,可以使用 react-router-dom 中的 useLocation 和 useNavigate 钩子来更新 URL 路径。
复制代码到剪贴板
import { useLocation, useNavigate } from "react-router-dom";import { Locales, getHTMLTextDir, getLocaleName, getLocalizedUrl,} from "intlayer";import { useLocale } from "react-intlayer";import { type FC } from "react";const LocaleSwitcher: FC = () => { const { pathname, search } = useLocation(); // 获取当前的 URL 路径。例如:/fr/about?foo=bar const navigate = useNavigate(); const { locale, availableLocales, setLocale } = useLocale({ onLocaleChange: (locale) => { // 构建带有更新后语言环境的 URL // 例如: /es/about?foo=bar const pathWithLocale = getLocalizedUrl(`${pathname}${search}`, locale); // 更新 URL 路径 navigate(pathWithLocale); }, }); return ( <div> <button popoverTarget="localePopover">{getLocaleName(locale)}</button> <div id="localePopover" popover="auto"> {availableLocales.map((localeItem) => ( <a href={getLocalizedUrl(location.pathname, localeItem)} hrefLang={localeItem} aria-current={locale === localeItem ? "page" : undefined} onClick={(e) => { e.preventDefault(); setLocale(localeItem); }} key={localeItem} > <span> {/* 语言环境 - 例如 FR */} {localeItem} </span> <span> {/* 该语言环境中的语言名称 - 例如 Français */} {getLocaleName(localeItem, locale)} </span> <span dir={getHTMLTextDir(localeItem)} lang={localeItem}> {/* 当前语言环境中的语言名称 - 例如当当前语言环境设置为 Locales.SPANISH 时显示 Francés */} {getLocaleName(localeItem)} </span> <span dir="ltr" lang={Locales.ENGLISH}> {/* 英文中的语言名称 - 例如 French */} {getLocaleName(localeItem, Locales.ENGLISH)} </span> </a> ))} </div> </div> );};
文档参考:
以下是更新后的步骤9,增加了解释并优化了代码示例:
(可选)步骤9:切换HTML的语言和方向属性
当您的应用程序支持多语言时,更新 <html> 标签的 lang 和 dir 属性以匹配当前语言环境非常重要。这样做可以确保:
- 无障碍访问:屏幕阅读器和辅助技术依赖正确的 lang 属性来准确发音和解释内容。
- 文本渲染:dir(方向)属性确保文本以正确的顺序呈现(例如,英语为从左到右,阿拉伯语或希伯来语为从右到左),这对于可读性至关重要。
- 搜索引擎优化(SEO):搜索引擎使用 lang 属性来确定页面的语言,有助于在搜索结果中提供正确的本地化内容。
通过在语言环境更改时动态更新这些属性,您可以确保所有支持语言的用户都能获得一致且无障碍的体验。
实现该 Hook
创建一个自定义 Hook 来管理 HTML 属性。该 Hook 监听语言环境的变化并相应地更新属性:
复制代码到剪贴板
import { useEffect } from "react";import { useLocale } from "react-intlayer";import { getHTMLTextDir } from "intlayer";/** * 根据当前语言环境更新 HTML <html> 元素的 `lang` 和 `dir` 属性。 * - `lang`:告知浏览器和搜索引擎页面的语言。 * - `dir`:确保正确的阅读顺序(例如,英语为 'ltr',阿拉伯语为 'rtl')。 * * 此动态更新对于正确的文本渲染、无障碍访问和搜索引擎优化至关重要。 */export const useI18nHTMLAttributes = () => { const { locale } = useLocale(); useEffect(() => { // 将语言属性更新为当前语言环境。 document.documentElement.lang = locale; // 根据当前语言环境设置文本方向。 document.documentElement.dir = getHTMLTextDir(locale); }, [locale]);};
在您的应用程序中使用该 Hook
将该 Hook 集成到您的主组件中,以便在语言环境更改时更新 HTML 属性:
复制代码到剪贴板
import type { FC } from "react";import { IntlayerProvider, useIntlayer } from "react-intlayer";import { useI18nHTMLAttributes } from "./hooks/useI18nHTMLAttributes";import "./App.css";const AppContent: FC = () => { // 应用该 Hook,根据当前语言环境更新 <html> 标签的 lang 和 dir 属性。 useI18nHTMLAttributes(); // ... 组件的其余部分};const App: FC = () => ( <IntlayerProvider> <AppContent /> </IntlayerProvider>);export default App;
在您的应用程序中使用 Hook
将该 Hook 集成到您的主组件中,以便在语言环境更改时更新 HTML 属性:
复制代码到剪贴板
import type { FC } from "react";import { IntlayerProvider, useIntlayer } from "react-intlayer";import { useI18nHTMLAttributes } from "./hooks/useI18nHTMLAttributes";import "./App.css";const AppContent: FC = () => { // 应用该 Hook,根据语言环境更新 <html> 标签的 lang 和 dir 属性。 useI18nHTMLAttributes(); // ... 组件的其余部分};const App: FC = () => ( <IntlayerProvider> <AppContent /> </IntlayerProvider>);export default App;
通过应用这些更改,您的应用程序将:
- 确保 语言 (lang) 属性正确反映当前语言环境,这对 SEO 和浏览器行为非常重要。
- 根据语言环境调整 文本方向 (dir),提升对不同阅读顺序语言的可读性和可用性。
- 提供更 无障碍 的体验,因为辅助技术依赖这些属性以实现最佳功能。
(可选)步骤 10:创建本地化链接组件
复制代码到剪贴板
// 应用该钩子以根据当前语言环境更新 <html> 标签的 lang 和 dir 属性。useI18nHTMLAttributes();// ... 组件的其余部分};const App = () => (<IntlayerProvider><AppContent /></IntlayerProvider>);module.exports = App;
通过应用这些更改,您的应用将能够:
- 确保 语言 (lang) 属性正确反映当前的语言环境,这对于 SEO 和浏览器行为非常重要。
- 根据语言环境调整 文本方向 (dir),提升不同阅读顺序语言的可读性和可用性。
- 提供更好的 无障碍 体验,因为辅助技术依赖这些属性来实现最佳功能。
(可选)步骤 10:创建本地化链接组件
为了确保您的应用程序的导航尊重当前的语言环境,您可以创建一个自定义的 Link 组件。该组件会自动为内部 URL 添加当前语言的前缀。例如,当讲法语的用户点击“关于”页面的链接时,他们会被重定向到 /fr/about,而不是 /about。
这种行为有几个好处:
- SEO 和用户体验:本地化的 URL 有助于搜索引擎正确索引特定语言的页面,并为用户提供其偏好的语言内容。
- 一致性:通过在整个应用中使用本地化链接,您可以确保导航保持在当前语言环境内,防止意外的语言切换。
- 可维护性:将本地化逻辑集中在单个组件中简化了 URL 的管理,使您的代码库更易于维护和扩展,随着应用程序的增长。
下面是一个使用 TypeScript 实现的本地化 Link 组件示例:
复制代码到剪贴板
import { getLocalizedUrl } from "intlayer";import { forwardRef, type DetailedHTMLProps, type AnchorHTMLAttributes,} from "react";import { useLocale } from "react-intlayer";export interface LinkProps extends DetailedHTMLProps< AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement > {}/** * 工具函数,用于检查给定的 URL 是否为外部链接。 * 如果 URL 以 http:// 或 https:// 开头,则视为外部链接。 */export const checkIsExternalLink = (href?: string): boolean => /^https?:\/\//.test(href ?? "");/** * 一个自定义的 Link 组件,根据当前语言环境动态调整 href 属性。 * 对于内部链接,使用 `getLocalizedUrl` 在 URL 前添加语言前缀(例如 /fr/about)。 * 这样可以确保导航保持在相同的语言环境上下文中。 */export const Link = forwardRef<HTMLAnchorElement, LinkProps>( ({ href, children, ...props }, ref) => { const { locale } = useLocale(); const isExternalLink = checkIsExternalLink(href); // 如果链接是内部链接且 href 有效,则获取本地化的 URL。 const hrefI18n = href && !isExternalLink ? getLocalizedUrl(href, locale) : href; return ( <a href={hrefI18n} ref={ref} {...props}> {children} </a> ); });Link.displayName = "Link";
工作原理
检测外部链接:
辅助函数 checkIsExternalLink 用于判断一个 URL 是否为外部链接。外部链接保持不变,因为它们不需要本地化。获取当前语言环境:
useLocale 钩子提供当前的语言环境(例如,法语为 fr)。本地化 URL:
对于内部链接(即非外部链接),使用 getLocalizedUrl 自动为 URL 添加当前语言环境前缀。这意味着如果用户使用的是法语,传入的 /about 会被转换为 /fr/about。返回链接:
该组件返回一个带有本地化 URL 的 <a> 元素,确保导航与当前语言环境保持一致。
通过在整个应用中集成此 Link 组件,您可以维护一致且具语言感知的用户体验,同时提升 SEO 和可用性。
配置 TypeScript
Intlayer 使用模块增强(module augmentation)来利用 TypeScript 的优势,使您的代码库更健壮。
确保您的 TypeScript 配置包含自动生成的类型。
复制代码到剪贴板
{ // ... 您现有的 TypeScript 配置 "include": [ // ... 您现有的 TypeScript 配置 ".intlayer/**/*.ts", // 包含自动生成的类型 ],}
Git 配置
建议忽略 Intlayer 生成的文件,这样可以避免将它们提交到您的 Git 仓库中。
为此,您可以在 .gitignore 文件中添加以下指令:
复制代码到剪贴板
# 忽略 Intlayer 生成的文件.intlayer
VS Code 扩展
为了提升您使用 Intlayer 的开发体验,您可以安装官方的 Intlayer VS Code 扩展。
该扩展提供:
- 翻译键的自动补全。
- 实时错误检测,用于缺失的翻译。
- 内联预览已翻译的内容。
- 快速操作,轻松创建和更新翻译。
有关如何使用该扩展的更多详细信息,请参阅Intlayer VS Code 扩展文档。
深入了解
要进一步使用,您可以实现可视化编辑器或使用内容管理系统(CMS)将内容外部化。
文档历史
- 5.5.10 - 2025-06-29:初始化历史