next-intlayer: 用于国际化 (i18n) Next.js 应用程序的 NPM 包

    Intlayer 是专为 JavaScript 开发人员设计的一套包。它兼容 React、Next.js 和 Express.js 等框架。

    next-intlayer 允许您国际化您的 Next.js 应用程序。它为 Next.js 国际化提供了上下文提供者和钩子。此外,它还包括用于将 Intlayer 与 WebpackTurbopack 集成的 Next.js 插件,以及用于检测用户首选语言环境、管理 Cookie 和处理 URL 重定向的中间件。

    为什么要国际化您的 Next.js 应用程序?

    国际化您的 Next.js 应用程序对于有效服务全球受众至关重要。它使您的应用程序能够以每个用户的首选语言传递内容和消息。这种能力增强了用户体验,并通过使您的应用程序对不同语言背景的人更具可访问性和相关性,从而扩大了应用程序的覆盖范围。

    为什么要集成 Intlayer?

    • JavaScript 驱动的内容管理:利用 JavaScript 的灵活性高效地定义和管理您的内容。
    • 类型安全环境:利用 TypeScript 确保您的所有内容定义精确且无错误。
    • 集成的内容文件:将翻译与其各自的组件紧密结合,增强可维护性和清晰性。

    安装

    使用您喜欢的包管理器安装必要的包:

    bash
    npm install next-intlayer

    使用示例

    使用 Intlayer,您可以在代码库中的任何地方以结构化的方式声明您的内容。

    默认情况下,Intlayer 会扫描扩展名为 .content.{ts,tsx,js,jsx,mjs,cjs} 的文件。

    您可以通过在配置文件中设置 contentDir 属性来修改默认扩展名。

    bash
    .├── intlayer.config.ts└── src    └── components        ├── ClientComponent        │   ├── index.content.ts        │   └── index.tsx        └── ServerComponent            ├── index.content.ts            └── index.tsx

    声明您的内容

    next-intlayer 是为与 intlayer一起使用而设计的。intlayer 是一个允许您在代码中的任何地方声明内容的包。它将多语言内容声明转换为结构化字典,并无缝集成到您的应用程序中。

    以下是内容声明的示例:

    tsx
    import { t, type Dictionary } from "intlayer";const clientComponentContent = {  key: "client-component",  content: {    myTranslatedContent: t({      en: "Hello World",      fr: "Bonjour le monde",      es: "Hola Mundo",      zh: "你好,世界",    }),    numberOfCar: enu({      "<-1": "少于负一辆车",      "-1": "负一辆车",      "0": "没有车",      "1": "一辆车",      ">5": "一些车",      ">19": "很多车",    }),  },} satisfies Dictionary;export default clientComponentContent;

    在代码中使用内容

    声明内容后,您可以在代码中使用它。以下是如何在 React 组件中使用内容的示例:

    src/components/ClientComponentExample.tsx
    "use client";import type { FC } from "react";import { useIntlayer } from "next-intlayer";export const ClientComponentExample: FC = () => {  const { myTranslatedContent } = useIntlayer("client-component"); // 创建相关内容声明  return (    <div>      <p>{myTranslatedContent}</p>    </div>  );};

    掌握 Next.js 应用程序的国际化

    Intlayer 提供了许多功能来帮助您国际化您的 Next.js 应用程序。以下是一些关键功能:

    • 服务器组件的国际化:Intlayer 允许您以与客户端组件相同的方式国际化服务器组件。这意味着您可以为客户端和服务器组件使用相同的内容声明。
    • 语言环境检测中间件:Intlayer 提供了用于检测用户首选语言环境的中间件。此中间件用于检测用户的首选语言环境,并将其重定向到配置中指定的适当 URL。
    • 元数据的国际化:Intlayer 提供了一种国际化元数据(例如页面标题)的方法,使用 Next.js 提供的 generateMetadata 函数。您可以使用 getTranslation 函数翻译元数据。
    • sitemap.xml 和 robots.txt 的国际化:Intlayer 允许您国际化 sitemap.xml 和 robots.txt 文件。您可以使用 getMultilingualUrls 函数生成多语言 URL 以供 sitemap 使用。
    • URL 的国际化:Intlayer 允许您通过使用 getMultilingualUrls 函数国际化 URL。此函数为您的 sitemap 生成多语言 URL。

    要了解更多关于这些功能的信息,请参阅 Next.js 国际化 (i18n) 与 Intlayer 和 Next.js 15 应用路由器 指南。

    next-intlayer 包提供的功能

    next-intlayer 包还提供了一些功能来帮助您国际化您的应用程序。

    如果您有改善此文档的想法,请随时通过在GitHub上提交拉取请求来贡献。

    文档的 GitHub 链接