- Documentation
- Packages
- intlayer
- getMultilingualUrls
Documentación: getMultilingualUrls Función en intlayer
Descripción:
La función getMultilingualUrls genera un mapeo de URLs multilingües al agregar el prefijo de cada locale soportado a la URL dada. Puede manejar tanto URLs absolutas como relativas, aplicando el prefijo de locale apropiado según la configuración proporcionada o por defecto.
Parámetros:
url: string
- Descripción: La cadena de URL original que se le añadirá el prefijo de locales.
- Tipo: string
locales: Locales[]
- Descripción: Array opcional de locales soportados. Por defecto se utilizan los locales configurados en el proyecto.
- Tipo: Locales[]
- Por Defecto: localesDefault
defaultLocale: Locales
- Descripción: El locale por defecto para la aplicación. Por defecto se utiliza el locale configurado como por defecto en el proyecto.
- Tipo: Locales
- Por Defecto: defaultLocaleDefault
prefixDefault: boolean
- Descripción: Si se debe agregar el prefijo del locale por defecto. Por defecto se utiliza el valor configurado en el proyecto.
- Tipo: boolean
- Por Defecto: prefixDefaultDefault
Retorna:
- Tipo: IConfigLocales<string>
- Descripción: Un objeto que mapea cada locale a su correspondiente URL multilingüe.
Ejemplo de Uso:
URLs Relativas:
1import { getMultilingualUrls, Locales } from "intlayer";
2
3getMultilingualUrls(
4 "/dashboard",
5 [Locales.ENGLISH, Locales.FRENCH],
6 Locales.ENGLISH,
7 false
8);
9// Salida: {
10// en: "/dashboard",
11// fr: "/fr/dashboard"
12// }URLs Absolutas:
1getMultilingualUrls(
2 "https://example.com/dashboard",
3 [Locales.ENGLISH, Locales.FRENCH],
4 Locales.ENGLISH,
5 true
6);
7// Salida: {
8// en: "https://example.com/en/dashboard",
9// fr: "https://example.com/fr/dashboard"
10// }Casos Límite:
Sin Segmento de Locale:
- La función elimina cualquier segmento de locale existente de la URL antes de generar los mapeos multilingües.
Locale por Defecto:
- Cuando prefixDefault es false, la función no agrega el prefijo en la URL para el locale por defecto.
Locales No Soportados:
- Solo se consideran los locales proporcionados en el array locales para generar las URLs.
Uso en Aplicaciones:
En una aplicación multilingüe, configurar los ajustes de internacionalización con locales y defaultLocale es fundamental para garantizar que se muestre el idioma correcto. A continuación, se muestra un ejemplo de cómo se puede usar getMultilingualUrls en la configuración de una aplicación:
1import { Locales, type IntlayerConfig } from "intlayer";
2
3// Configuración para locales soportados y locale por defecto
4export default {
5 internationalization: {
6 locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
7 defaultLocale: Locales.ENGLISH,
8 },
9} satisfies IntlayerConfig;
10
11export default config;La configuración anterior asegura que la aplicación reconozca ENGLISH, FRENCH y SPANISH como idiomas soportados y use ENGLISH como el idioma por defecto.
Utilizando esta configuración, la función getMultilingualUrls puede generar dinámicamente mapeos de URLs multilingües basados en los locales soportados de la aplicación:
1getMultilingualUrls(
2 "/dashboard",
3 [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
4 Locales.ENGLISH
5);
6// Salida:
7// {
8// en: "/dashboard",
9// fr: "/fr/dashboard",
10// es: "/es/dashboard"
11// }
12
13getMultilingualUrls(
14 "https://example.com/dashboard",
15 [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
16 Locales.ENGLISH,
17 true
18);
19// Salida:
20// {
21// en: "https://example.com/en/dashboard",
22// fr: "https://example.com/fr/dashboard",
23// es: "https://example.com/es/dashboard"
24// }Al integrar getMultilingualUrls, los desarrolladores pueden mantener estructuras de URL consistentes en múltiples idiomas, mejorando tanto la experiencia del usuario como el SEO.
Si tienes una idea para mejorar esta documentación, no dudes en contribuir enviando una pull request en GitHub.
Enlace de GitHub a la documentación