@intlayer/docs 8.12.5-canary.0 → 9.0.0-canary.10

package/docs/zh/intlayer_with_tanstack.md

@@ -1,6 +1,6 @@
 ---
 createdAt: 2025-09-09
-updatedAt: 2026-05-31
+updatedAt: 2026-06-23
 title: "TanStack Start i18n - 翻译你的应用的完整指南"
 description: "告别 i18next。2026 年构建多语言 (i18n) TanStack Start 应用的完整指南。使用 AI 代理翻译并优化包体积、SEO 和性能。"
 keywords:
@@ -90,275 +90,6 @@ Intlayer 不仅仅是一个 i18n 解决方案，还提供了一个**自托管的
 
 ---
 
-## 在 Tanstack Start 应用中设置 Intlayer 的分步指南
-
-<Tabs defaultTab="video">
-  <Tab label="视频" value="video">
-  
-<iframe title="Tanstack Start 的最佳 i18n 解决方案？发现 Intlayer" class="m-auto aspect-16/9 w-full overflow-hidden rounded-lg border-0" allow="autoplay; gyroscope;" loading="lazy" width="1080" height="auto" src="https://www.youtube.com/embed/_XTdKVWaeqg?autoplay=0&amp;origin=https://intlayer.org&amp;controls=0&amp;rel=1"/>
-
-  </Tab>
-  <Tab label="代码" value="code">
-
-<iframe
-  src="https://ide.intlayer.org/aymericzip/intlayer-tanstack-start-template?file=intlayer.config.ts"
-  className="m-auto overflow-hidden rounded-lg border-0 max-md:size-full max-md:h-[700px] md:aspect-16/9 md:w-full"
-  title="演示 CodeSandbox - 如何使用 Intlayer 国际化您的应用程序"
-  sandbox="allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts"
-  loading="lazy"
-/>
-
-  </Tab>
-  <Tab label="演示" value="demo">
-
-<iframe
-  src="https://intlayer-tanstack-start-template.vercel.app"
-  className="m-auto overflow-hidden rounded-lg border-0 max-md:size-full max-md:h-[700px] md:aspect-16/9 md:w-full"
-  title="演示 - intlayer-tanstack-start-template"
-  sandbox="allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts"
-  loading="lazy"
-/>
-
-  </Tab>
-</Tabs>
-
-在 GitHub 上查看[应用程序模板](https://github.com/aymericzip/intlayer-tanstack-start-template)。
-
-### 第一步：创建项目
-
-首先，按照 TanStack Start 网站上的[新建项目](https://tanstack.com/start/latest/docs/framework/react/quick-start)指南创建一个新的 TanStack Start 项目。
-
-### 第二步：安装 Intlayer 包
-
-使用您喜欢的包管理器安装所需的包：
-
-```bash packageManager="npm"
-npm install intlayer react-intlayer
-npm install vite-intlayer --save-dev
-npx intlayer init
-```
-
-```bash packageManager="pnpm"
-pnpm add intlayer react-intlayer
-pnpm add vite-intlayer --save-dev
-pnpm intlayer init
-```
-
-```bash packageManager="yarn"
-yarn add intlayer react-intlayer
-yarn add vite-intlayer --save-dev
-yarn intlayer init
-```
-
-```bash packageManager="bun"
-bun add intlayer react-intlayer
-bun add vite-intlayer --dev
-bun x intlayer init
-```
-
-- **intlayer**
-
-  核心包，提供用于配置管理、翻译、[内容声明](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/dictionary/content_file.md)，转译以及[命令行工具](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/cli/index.md)的国际化工具。
-
-- **react-intlayer**  
-  将 Intlayer 集成到 React 应用中的包。它为 React 国际化提供上下文提供者和钩子。
-
-- **vite-intlayer**  
-  包含用于将 Intlayer 集成到[Vite 打包器](https://vite.dev/guide/why.html#why-bundle-for-production)的 Vite 插件，以及用于检测用户首选语言、管理 Cookie 和处理 URL 重定向的中间件。
-
-### 第三步：项目配置
-
-创建一个配置文件来配置您的应用程序语言：
-
-```typescript fileName="intlayer.config.ts"
-import type { IntlayerConfig } from "intlayer";
-
-import { Locales } from "intlayer";
-
-const config: IntlayerConfig = {
-  internationalization: {
-    defaultLocale: Locales.ENGLISH,
-    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
-  },
-};
-
-export default config;
-```
-
-> 通过此配置文件，您可以设置本地化 URL、中间件重定向、cookie 名称、内容声明的位置和扩展名、禁用控制台中的 Intlayer 日志等。有关可用参数的完整列表，请参阅[配置文档](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/configuration.md)。
-
-### 第四步：在您的 Vite 配置中集成 Intlayer
-
-将 intlayer 插件添加到您的配置中：
-
-```typescript fileName="vite.config.ts"
-import { tanstackStart } from "@tanstack/react-start/plugin/vite";
-import viteReact from "@vitejs/plugin-react";
-import { nitro } from "nitro/vite";
-import { defineConfig } from "vite";
-import { intlayer } from "vite-intlayer";
-
-const config = defineConfig({
-  plugins: [
-    nitro(),
-    intlayer(),
-    tanstackStart({
-      router: {
-        routeFileIgnorePattern:
-          ".content.(ts|tsx|js|mjs|cjs|jsx|json|jsonc|json5)$",
-      },
-    }),
-    viteReact(),
-  ],
-});
-
-export default config;
-```
-
-> `intlayer()` Vite 插件用于将 Intlayer 集成到 Vite 中。它确保构建内容声明文件并在开发模式下监视它们。它在 Vite 应用中定义了 Intlayer 环境变量。此外，它还提供别名以优化性能。
-
-### 第五步：创建根布局
-
-配置您的根布局以支持国际化，使用 `useParams` 检测当前 locale 并在 `html` 标签上设置 `lang` 和 `dir` 属性。
-
-```tsx fileName="src/routes/__root.tsx"
-import {
-  createRootRouteWithContext,
-  HeadContent,
-  Scripts,
-} from "@tanstack/react-router";
-import { defaultLocale, getHTMLTextDir } from "intlayer";
-import { type ReactNode } from "react";
-import { IntlayerProvider } from "react-intlayer";
-import { Route as LocaleRoute } from "./{-$locale}/route";
-
-export const Route = createRootRouteWithContext<{}>()({
-  head: () => ({
-    meta: [
-      {
-        charSet: "utf-8",
-      },
-      {
-        content: "width=device-width, initial-scale=1",
-        name: "viewport",
-      },
-      {
-        title: "TanStack Start Starter",
-      },
-    ],
-  }),
-
-  shellComponent: RootDocument,
-});
-
-function RootDocument({ children }: { children: ReactNode }) {
-  const params = LocaleRoute.useParams();
-  const locale = params?.locale ?? defaultLocale;
-
-  return (
-    <html dir={getHTMLTextDir(locale)} lang={locale}>
-      <head>
-        <HeadContent />
-      </head>
-      <body>
-        <IntlayerProvider locale={locale}>{children}</IntlayerProvider>
-        <Scripts />
-      </body>
-    </html>
-  );
-}
-```
-
-> 如果您想在字符串属性中使用内容，比如 `alt`、`title`、`href`、`aria-label` 等，可以使用函数的值，例如：
-
-> ```html
-> <img src="{content.image.src.value}" alt="{content.image.value}" />
-> <img src="{content.image.src.toString()}" alt="{content.image.toString()}" />
-> <img src="{String(content.image.src)}" alt="{String(content.image)}" />
-> ```
-
-### 第六步：创建 Locale 布局
-
-创建一个处理 locale 前缀并执行验证的布局。
-
-```tsx fileName="src/routes/{-$locale}/route.tsx"
-import { createFileRoute, Outlet, redirect } from "@tanstack/react-router";
-import { validatePrefix } from "intlayer";
-
-export const Route = createFileRoute("/{-$locale}")({
-  beforeLoad: ({ params }) => {
-    const localeParam = params.locale;
-
-    // 验证 locale 前缀
-    const { isValid, localePrefix } = validatePrefix(localeParam);
-
-    if (!isValid) {
-      throw redirect({
-        to: "/{-$locale}/404",
-        params: { locale: localePrefix },
-      });
-    }
-  },
-  component: Outlet,
-});
-```
-
-> 这里，`{-$locale}` 是一个动态路由参数，会被当前 locale 替换。此表示法使插槽可选，允许它与 `'prefix-no-default'` 等路由模式一起工作。
-
-> 请注意，如果您在同一路由中使用多个动态段（例如，`/{-$locale}/other-path/$anotherDynamicPath/...`），此插槽可能会导致问题。
-> 对于 `'prefix-all'` 模式，您可能更喜欢将插槽切换为 `$locale`。
-> 对于 `'no-prefix'` 或 `'search-params'` 模式，您可以完全删除插槽。
-
-### 第七步：声明您的内容
-
-创建并管理您的内容声明以存储翻译：
-
-```tsx fileName="src/contents/page.content.ts"
-import type { Dictionary } from "intlayer";
-
-import { t } from "intlayer";
-
-const appContent = {
-  content: {
-    links: {
-      about: t({
-        zh: "关于",
-        en: "About",
-        es: "Acerca de",
-        fr: "À propos",
-      }),
-      home: t({
-        zh: "首页",
-        en: "Home",
-        es: "Inicio",
-        fr: "Accueil",
-      }),
-    },
-    meta: {
-      title: t({
-        zh: "欢迎使用 Intlayer + TanStack Router",
-        en: "Welcome to Intlayer + TanStack Router",
-        es: "Bienvenido a Intlayer + TanStack Router",
-        fr: "Bienvenue à Intlayer + TanStack Router",
-      }),
-      description: t({
-        zh: "这是一个使用 Intlayer 和 TanStack Router 的示例",
-        en: "This is an example of using Intlayer with TanStack Router",
-        es: "Este es un ejemplo de uso de Intlayer con TanStack Router",
-        fr: "Ceci est un exemple d'utilisation d'Intlayer avec TanStack Router",
-      }),
-    },
-  },
-  key: "app",
-} satisfies Dictionary;
-
-export default appContent;
-```
-
-> 您的内容声明可以在应用程序中的任何位置定义，只要它们被包含在 `contentDir` 目录中（默认是 `./app`）。并且文件扩展名需匹配内容声明文件扩展名（默认是 `.content.{json,ts,tsx,js,jsx,mjs,cjs,md,mdx,yaml,yml}`）。
-
-> 更多详情，请参阅[内容声明文档](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/dictionary/content_file.md)。
-
 ### 第八步：创建支持多语言的组件和钩子
 
 创建一个用于多语言导航的 `LocalizedLink` 组件：
@@ -463,54 +194,6 @@ export const useLocalizedNavigate = () => {
 };
 ```
 
-### 第九步：在您的页面中使用 Intlayer
-
-在整个应用程序中访问您的内容字典：
-
-#### 本地化首页
-
-```tsx fileName="src/routes/{-$locale}/index.tsx"
-import { createFileRoute } from "@tanstack/react-router";
-import { getIntlayer } from "intlayer";
-import { useIntlayer } from "react-intlayer";
-
-import LocaleSwitcher from "@/components/locale-switcher";
-import { LocalizedLink } from "@/components/localized-link";
-import { useLocalizedNavigate } from "@/hooks/useLocalizedNavigate";
-
-export const Route = createFileRoute("/{-$locale}/")({
-  component: RouteComponent,
-});
-
-function RouteComponent() {
-  const content = useIntlayer("app");
-  const navigate = useLocalizedNavigate();
-
-  return (
-    <div>
-      <div>
-        {content.title}
-        <LocaleSwitcher />
-        <div>
-          <LocalizedLink to="/">{content.links.home}</LocalizedLink>
-          <LocalizedLink to="/about">{content.links.about}</LocalizedLink>
-        </div>
-        <div>
-          <button onClick={() => navigate({ to: "/" })}>
-            {content.links.home}
-          </button>
-          <button onClick={() => navigate({ to: "/about" })}>
-            {content.links.about}
-          </button>
-        </div>
-      </div>
-    </div>
-  );
-}
-```
-
-> 要了解更多关于 `useIntlayer` 钩子的内容，请参阅[文档](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/react-intlayer/useIntlayer.md)。
-
 ### 第十步：创建语言切换组件
 
 创建一个组件，允许用户切换语言：
@@ -572,298 +255,6 @@ export const LocaleSwitcher: FC = () => {
 
 > 要了解有关 `useLocale` 钩子的更多信息，请参阅[文档](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/react-intlayer/useLocale.md)。
 
-### 第十一步：HTML 属性管理
-
-如第5步所示，您可以在根组件中使用 `useParams` 管理 `html` 标签的 `lang` 和 `dir` 属性。这确保在服务器和客户端上正确设置属性。
-
-```tsx fileName="src/routes/__root.tsx"
-function RootDocument({ children }: { children: ReactNode }) {
-  const params = LocaleRoute.useParams();
-  const locale = params?.locale ?? defaultLocale;
-
-  return (
-    <html dir={getHTMLTextDir(locale)} lang={locale}>
-      {/* ... */}
-    </html>
-  );
-}
-```
-
----
-
-### 第十二步：添加中间件（可选）
-
-您还可以使用 `intlayerProxy` 为您的应用程序添加服务器端路由。该插件将根据 URL 自动检测当前语言环境，并设置相应的语言环境 Cookie。如果未指定语言环境，插件将根据用户浏览器的语言偏好确定最合适的语言环境。如果未检测到语言环境，它将重定向到默认语言环境。
-
-> 注意，要在生产环境中使用 `intlayerProxy`，您需要将 `vite-intlayer` 包从 `devDependencies` 切换到 `dependencies`。
-
-```typescript {7,14-17} fileName="vite.config.ts"
-import { tanstackStart } from "@tanstack/react-start/plugin/vite";
-import viteReact from "@vitejs/plugin-react";
-import { nitro } from "nitro/vite";
-import { defineConfig } from "vite";
-import { intlayer, intlayerProxy } from "vite-intlayer";
-
-export default defineConfig({
-  plugins: [
-    intlayerProxy(), // 如果使用 Nitro，代理应放在服务器之前
-    nitro(),
-    intlayer(),
-    tanstackStart({
-      router: {
-        routeFileIgnorePattern:
-          ".content.(ts|tsx|js|mjs|cjs|jsx|json|jsonc|json5)$",
-      },
-    }),
-    viteReact(),
-  ],
-});
-```
-
----
-
-### 第十二步：国际化您的元数据（可选）
-
-您还可以使用 `getIntlayer` 钩子在整个应用程序中访问您的内容字典：
-
-```tsx fileName="src/routes/{-$locale}/index.tsx"
-import { createFileRoute } from "@tanstack/react-router";
-import { getIntlayer } from "intlayer";
-
-export const Route = createFileRoute("/{-$locale}/")({
-  component: RouteComponent,
-  head: ({ params }) => {
-    const { locale } = params;
-    const path = "/"; // The path for this route
-
-    const metaContent = getIntlayer("app", locale);
-
-    return {
-      links: [
-        // Canonical link: Points to the current localized page
-        { rel: "canonical", href: getLocalizedUrl(path, locale) },
-
-        // Hreflang: Tell Google about all localized versions
-        ...localeMap(({ locale: mapLocale }) => ({
-          rel: "alternate",
-          hrefLang: mapLocale,
-          href: getLocalizedUrl(path, mapLocale),
-        })),
-
-        // x-default: For users in unmatched languages
-        // Define the default fallback locale (usually your primary language)
-        {
-          rel: "alternate",
-          hrefLang: "x-default",
-          href: getLocalizedUrl(path, defaultLocale),
-        },
-      ],
-      meta: [
-        { title: metaContent.title },
-        { name: "description", content: metaContent.meta.description },
-      ],
-    };
-  },
-});
-```
-
----
-
-### 第十三步：在您的 server actions 中获取 locale（可选）
-
-您可能希望从 server actions 或 API 端点内部访问当前 locale。
-您可以使用 `intlayer` 中的 `getLocale` 辅助函数来实现这一点。
-
-以下是使用 TanStack Start 的 server functions 的示例：
-
-```tsx fileName="src/routes/{-$locale}/index.tsx"
-import { createServerFn } from "@tanstack/react-start";
-import {
-  getRequestHeader,
-  getRequestHeaders,
-} from "@tanstack/react-start/server";
-import { getCookie, getIntlayer, getLocale } from "intlayer";
-
-export const getLocaleServer = createServerFn().handler(async () => {
-  const locale = await getLocale({
-    // 从请求中获取 cookie（默认：'INTLAYER_LOCALE'）
-    getCookie: (name) => {
-      const cookieString = getRequestHeader("cookie");
-
-      return getCookie(name, cookieString);
-    },
-    // 从请求中获取 header（默认：'x-intlayer-locale'）
-    // 使用 Accept-Language 协商作为后备
-    getHeader: (name) => getRequestHeader(name),
-  });
-
-  // 使用 getIntlayer() 检索一些内容
-  const content = getIntlayer("app", locale);
-
-  return { locale, content };
-});
-```
-
----
-
-### 第十四步：管理未找到的页面（可选）
-
-当用户访问不存在的页面时，您可以显示自定义的未找到页面，并且区域设置前缀可能会影响未找到页面的触发方式。
-
-#### 了解 TanStack Router 使用区域设置前缀的 404 处理
-
-在 TanStack Router 中，使用本地化路由处理 404 页面需要采用多层方法：
-
-1. **专用 404 路由**：用于显示 404 UI 的特定路由
-2. **路由级验证**：验证区域设置前缀并将无效的前缀重定向到 404
-3. **捕获所有路由**：捕获区域设置段内任何不匹配的路径
-
-```tsx fileName="src/routes/{-$locale}/404.tsx"
-import { createFileRoute } from "@tanstack/react-router";
-
-// 这将创建一个专用的 /[locale]/404 路由
-// 它既作为直接路由使用，也可以在其他文件中作为组件导入
-export const Route = createFileRoute("/{-$locale}/404")({
-  component: NotFoundComponent,
-});
-
-// 单独导出，以便可以在 notFoundComponent 和 catch-all 路由中重用
-export function NotFoundComponent() {
-  return (
-    <div>
-      <h1>404</h1>
-    </div>
-  );
-}
-```
-
-```tsx fileName="src/routes/{-$locale}/route.tsx"
-import { createFileRoute, Outlet, redirect } from "@tanstack/react-router";
-import { validatePrefix } from "intlayer";
-import { NotFoundComponent } from "./404";
-
-export const Route = createFileRoute("/{-$locale}")({
-  // beforeLoad 在路由渲染之前运行（在服务器和客户端上）
-  // 这是验证 locale 前缀的理想位置
-  beforeLoad: ({ params }) => {
-    const localeParam = params.locale;
-
-    // validatePrefix 检查 locale 是否根据您的 intlayer 配置有效
-    const { isValid, localePrefix } = validatePrefix(localeParam);
-
-    if (!isValid) {
-      // 无效的 locale 前缀 - 重定向到具有有效 locale 前缀的 404 页面
-      throw redirect({
-        to: "/{-$locale}/404",
-        params: { locale: localePrefix },
-      });
-    }
-  },
-  component: Outlet,
-  // notFoundComponent 在子路由不存在时被调用
-  // 例如，/en/不存在的页面 在 /en 布局内触发此操作
-  notFoundComponent: NotFoundComponent,
-});
-```
-
-```tsx fileName="src/routes/{-$locale}/$.tsx"
-import { createFileRoute } from "@tanstack/react-router";
-
-import { NotFoundComponent } from "./404";
-
-// $ (splat/catch-all) 路由匹配任何与其他路由不匹配的路径
-// 例如，/en/某个/深度/嵌套/无效/路径
-// 这确保区域设置内所有不匹配的路径都显示 404 页面
-// 没有这个，不匹配的深层路径可能会显示空白页面或错误
-export const Route = createFileRoute("/{-$locale}/$")({
-  component: NotFoundComponent,
-});
-```
-
----
-
-### 第十五步：提取组件中的内容（可选）
-
-如果您有现有的代码库，转换数千个文件可能会非常耗时。
-
-为了简化此过程，Intlayer 提供了 [编译器](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/compiler.md) / [提取器](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/cli/extract.md) 来转换您的组件并提取内容。
-
-要进行设置，您可以在 `intlayer.config.ts` 文件中添加 `compiler` 部分：
-
-```typescript fileName="intlayer.config.ts" codeFormat="typescript"
-import { type IntlayerConfig } from "intlayer";
-
-const config: IntlayerConfig = {
-  // ... 您的其他配置
-  compiler: {
-    /**
-     * 指示是否应启用编译器。
-     */
-    enabled: true,
-
-    /**
-     * 定义输出文件路径
-     */
-    output: ({ fileName, extension }) => `./${fileName}${extension}`,
-
-    /**
-     * 指示在转换后是否应保存组件。这样，编译器只需运行一次即可转换应用程序，然后即可将其删除。
-     */
-    saveComponents: false,
-
-    /**
-     * 字典键前缀
-     */
-    dictionaryKeyPrefix: "",
-  },
-};
-
-export default config;
-```
-
-<Tabs>
- <Tab value='提取命令'>
-
-运行提取器以转换组件并提取内容
-
-```bash packageManager="npm"
-npx intlayer extract
-```
-
-```bash packageManager="pnpm"
-pnpm intlayer extract
-```
-
-```bash packageManager="yarn"
-yarn intlayer extract
-```
-
-```bash packageManager="bun"
-bun x intlayer extract
-```
-
- </Tab>
- <Tab value='Babel 编译器'>
-
-更新您的 `vite.config.ts` 以包含 `intlayerCompiler` 插件：
-
-```ts fileName="vite.config.ts"
-import { defineConfig } from "vite";
-import { intlayer, intlayerCompiler } from "vite-intlayer";
-
-export default defineConfig({
-  plugins: [
-    intlayer(),
-    intlayerCompiler(), // 添加编译器插件
-  ],
-});
-```
-
- </Tab>
-</Tabs>
-
----
-
 ### 第十六步：生成站点地图 (Sitemap)（可选）
 
 Intlayer 附带一个内置的站点地图生成器，可帮助您轻松为应用程序创建站点地图。它能够处理本地化路由，并为搜索引擎添加必要的元数据。
@@ -939,24 +330,6 @@ export const Route = createFileRoute("/sitemap.xml")({
 
 ---
 
-### 第十七步：TypeScript 配置 (可选)
-
-Intlayer 通过模块扩充来利用 TypeScript 的优势，增强您的代码库。
-
-确保自动生成的类型已包含在您的 TypeScript 配置中。
-
-```json5 fileName="tsconfig.json"
-{
-  // ... 现有配置
-  include: [
-    // ... 现有包含
-    ".intlayer/**/*.ts", // 包含自动生成的类型
-  ],
-}
-```
-
----
-
 ### Git 配置
 
 建议忽略 Intlayer 生成的文件。这样可以避免将它们提交到您的 Git 仓库中。