文档: getMultilingualUrls 函数在 intlayer 中

描述

getMultilingualUrls 函数通过为给定的 URL 添加每个支持的语言环境前缀来生成多语言 URL 的映射。它可以处理绝对和相对 URL，根据提供的配置或默认值应用适当的语言环境前缀。

参数

• url: string

  • 描述: 要添加语言环境前缀的原始 URL 字符串。
  • 类型: string

• locales: Locales[]

  • 描述: 可选的支持语言环境数组。默认为项目中配置的语言环境。
  • 类型: Locales[]
  • 默认值: localesDefault

• defaultLocale: Locales

  • 描述: 应用程序的默认语言环境。默认为项目中配置的默认语言环境。
  • 类型: Locales
  • 默认值: defaultLocaleDefault

• prefixDefault: boolean

  • 描述: 是否为默认语言环境添加前缀。默认为项目中配置的值。
  • 类型: boolean
  • 默认值: prefixDefaultDefault

返回值

• 类型: IConfigLocales<string>
• 描述: 一个将每个语言环境映射到其对应的多语言 URL 的对象。

示例用法

相对 URL

import { getMultilingualUrls, Locales } from "intlayer";getMultilingualUrls(  "/dashboard",  [Locales.ENGLISH, Locales.FRENCH],  Locales.ENGLISH,  false);// 输出: {//   en: "/dashboard",//   fr: "/fr/dashboard"// }

绝对 URL

getMultilingualUrls(  "https://example.com/dashboard",  [Locales.ENGLISH, Locales.FRENCH],  Locales.ENGLISH,  true);// 输出: {//   en: "https://example.com/en/dashboard",//   fr: "https://example.com/fr/dashboard"// }

边界情况

• 没有语言环境段:

  • 函数在生成多语言映射之前，会从 URL 中移除任何现有的语言环境段。

• 默认语言环境:

  • 当 prefixDefault 为 false 时，函数不会为默认语言环境添加前缀。

• 不支持的语言环境:

  • 仅考虑 locales 数组中提供的语言环境来生成 URL。

在应用程序中的使用

在多语言应用程序中，使用 locales 和 defaultLocale 配置国际化设置对于确保显示正确的语言至关重要。以下是如何在应用程序设置中使用 getMultilingualUrls 的示例:

import { Locales, type IntlayerConfig } from "intlayer";// 支持的语言环境和默认语言环境的配置export default {  internationalization: {    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],    defaultLocale: Locales.ENGLISH,  },} satisfies IntlayerConfig;export default config;

上述配置确保应用程序识别 ENGLISH、FRENCH 和 SPANISH 作为支持的语言，并使用 ENGLISH 作为回退语言。

使用此配置，getMultilingualUrls 函数可以根据应用程序支持的语言环境动态生成多语言 URL 映射:

getMultilingualUrls(  "/dashboard",  [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],  Locales.ENGLISH);// 输出:// {//   en: "/dashboard",//   fr: "/fr/dashboard",//   es: "/es/dashboard"// }getMultilingualUrls(  "https://example.com/dashboard",  [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],  Locales.ENGLISH,  true);// 输出:// {//   en: "https://example.com/en/dashboard",//   fr: "https://example.com/fr/dashboard",//   es: "https://example.com/es/dashboard"// }

通过集成 getMultilingualUrls，开发人员可以在多种语言中保持一致的 URL 结构，从而增强用户体验和 SEO。