- Documentation
- Packages
- intlayer
- getMultilingualUrls
Documentation: getMultilingualUrls Function in intlayer
Description:
La fonction getMultilingualUrls génère un mappage d'URL multilingues en préfixant l'URL donnée avec chaque locale supportée. Elle peut traiter à la fois des URL absolues et relatives, appliquant le préfixe de locale approprié basé sur la configuration fournie ou les valeurs par défaut.
Parameters:
url: string
- Description: La chaîne d'URL originale à préfixer avec les locales.
- Type: string
locales: Locales[]
- Description: Tableau optionnel de locales supportées. Par défaut, utilise les locales configurées dans le projet.
- Type: Locales[]
- Default: localesDefault
defaultLocale: Locales
- Description: La locale par défaut pour l'application. Par défaut, utilise la locale par défaut configurée dans le projet.
- Type: Locales
- Default: defaultLocaleDefault
prefixDefault: boolean
- Description: Indique s'il faut préfixer la locale par défaut. Par défaut, utilise la valeur configurée dans le projet.
- Type: boolean
- Default: prefixDefaultDefault
Returns:
- Type: IConfigLocales<string>
- Description: Un objet mappant chaque locale à son URL multilingue correspondante.
Example Usage:
Relative URLs:
1import { getMultilingualUrls, Locales } from "intlayer";
2
3getMultilingualUrls(
4 "/dashboard",
5 [Locales.ENGLISH, Locales.FRENCH],
6 Locales.ENGLISH,
7 false
8);
9// Output: {
10// en: "/dashboard",
11// fr: "/fr/dashboard"
12// }Absolute URLs:
1getMultilingualUrls(
2 "https://example.com/dashboard",
3 [Locales.ENGLISH, Locales.FRENCH],
4 Locales.ENGLISH,
5 true
6);
7// Output: {
8// en: "https://example.com/en/dashboard",
9// fr: "https://example.com/fr/dashboard"
10// }Edge Cases:
No Locale Segment:
- La fonction supprime tout segment de locale existant de l'URL avant de générer les mappages multilingues.
Default Locale:
- Lorsque prefixDefault est false, la fonction ne préfixe pas l'URL pour la locale par défaut.
Unsupported Locales:
- Seules les locales fournies dans le tableau locales sont considérées pour la génération des URL.
Usage in Applications:
Dans une application multilingue, la configuration des paramètres d'internationalisation avec locales et defaultLocale est essentielle pour garantir que la langue correcte soit affichée. Voici un exemple de la façon dont getMultilingualUrls peut être utilisé dans une configuration d'application :
1import { Locales, type IntlayerConfig } from "intlayer";
2
3// Configuration pour les locales supportées et la locale par défaut
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 configuration ci-dessus garantit que l'application reconnaisse ENGLISH, FRENCH, et SPANISH comme langues supportées et utilise ENGLISH comme langue par défaut.
En utilisant cette configuration, la fonction getMultilingualUrls peut générer dynamiquement des mappages d'URL multilingues basés sur les locales supportées par l'application :
1getMultilingualUrls(
2 "/dashboard",
3 [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
4 Locales.ENGLISH
5);
6// Output:
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// Output:
20// {
21// en: "https://example.com/en/dashboard",
22// fr: "https://example.com/fr/dashboard",
23// es: "https://example.com/es/dashboard"
24// }En intégrant getMultilingualUrls, les développeurs peuvent maintenir des structures d'URL cohérentes à travers plusieurs langues, améliorant ainsi l'expérience utilisateur et le SEO.
Si vous avez une idée d’amélioration pour améliorer cette documentation, n’hésitez pas à contribuer en submitant une pull request sur GitHub.
Lien GitHub de la documentation