Dokumentation: getLocalizedUrl Funktion in intlayer

Beschreibung

Die Funktion getLocalizedUrl generiert eine lokalisierte URL, indem sie die angegebene URL mit dem angegebenen Gebietsschema (Locale) präfixiert. Sie verarbeitet sowohl absolute als auch relative URLs und stellt sicher, dass das korrekte Locale-Präfix basierend auf der Konfiguration angewendet wird.

Parameter

• url: string

  • Beschreibung: Die ursprüngliche URL-Zeichenkette, die mit einem Locale präfixiert werden soll.
  • Typ: string

• currentLocale: Locales

  • Beschreibung: Das aktuelle Locale, für das die URL lokalisiert wird.
  • Typ: Locales

• locales: Locales[]

  • Beschreibung: Optionale Liste der unterstützten Locales. Standardmäßig werden die in der Projektkonfiguration angegebenen Locales verwendet.
  • Typ: Locales[]
  • Standard: Projektkonfiguration

• defaultLocale: Locales

  • Beschreibung: Das Standard-Locale der Anwendung. Standardmäßig wird das in der Projektkonfiguration angegebene Standard-Locale verwendet.
  • Typ: Locales
  • Standard: Projektkonfiguration

• prefixDefault: boolean

  • Beschreibung: Gibt an, ob die URL für das Standard-Locale präfixiert werden soll. Standardmäßig wird der in der Projektkonfiguration angegebene Wert verwendet.
  • Typ: boolean
  • Standard: Projektkonfiguration

Rückgabewert

• Typ: string
• Beschreibung: Die lokalisierte URL für das angegebene Locale.

Beispielverwendung

Relative URLs

import { getLocalizedUrl, Locales } from "intlayer";getLocalizedUrl(  "/about",  Locales.FRENCH,  [Locales.ENGLISH, Locales.FRENCH],  Locales.ENGLISH,  false);// Ausgabe: "/fr/about" für das französische Locale// Ausgabe: "/about" für das Standard-Locale (Englisch)

Absolute URLs

getLocalizedUrl(  "https://example.com/about",  Locales.FRENCH, // Aktuelles Locale  [Locales.ENGLISH, Locales.FRENCH], // Unterstützte Locales  Locales.ENGLISH, // Standard-Locale  false // Standard-Locale präfixieren); // Ausgabe: "https://example.com/fr/about" für FranzösischgetLocalizedUrl(  "https://example.com/about",  Locales.ENGLISH, // Aktuelles Locale  [Locales.ENGLISH, Locales.FRENCH], // Unterstützte Locales  Locales.ENGLISH, // Standard-Locale  false // Standard-Locale präfixieren); // Ausgabe: "https://example.com/about" für EnglischgetLocalizedUrl(  "https://example.com/about",  Locales.ENGLISH, // Aktuelles Locale  [Locales.ENGLISH, Locales.FRENCH], // Unterstützte Locales  Locales.ENGLISH, // Standard-Locale  true // Standard-Locale präfixieren); // Ausgabe: "https://example.com/en/about" für Englisch

Nicht unterstütztes Locale

getLocalizedUrl(  "/about",  Locales.ITALIAN, // Aktuelles Locale  [Locales.ENGLISH, Locales.FRENCH], // Unterstützte Locales  Locales.ENGLISH // Standard-Locale); // Ausgabe: "/about" (kein Präfix für nicht unterstütztes Locale)

Randfälle

• Kein Locale-Segment:

  • Wenn die URL kein Locale-Segment enthält, fügt die Funktion sicher das entsprechende Locale-Präfix hinzu.

• Standard-Locale:

  • Wenn prefixDefault auf false gesetzt ist, fügt die Funktion kein Präfix für das Standard-Locale hinzu.

• Nicht unterstützte Locales:

  • Für Locales, die nicht in locales aufgeführt sind, wird kein Präfix angewendet.

Verwendung in Anwendungen

In einer mehrsprachigen Anwendung ist die Konfiguration der Internationalisierungseinstellungen mit locales und defaultLocale entscheidend, um sicherzustellen, dass die richtige Sprache angezeigt wird. Unten ist ein Beispiel, wie getLocalizedUrl in einer Anwendungskonfiguration verwendet werden kann:

import { Locales, type IntlayerConfig } from "intlayer";// Konfiguration für unterstützte Locales und Standard-Localeexport default {  internationalization: {    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],    defaultLocale: Locales.ENGLISH,  },} satisfies IntlayerConfig;export default config;

Die obige Konfiguration stellt sicher, dass die Anwendung ENGLISH, FRENCH und SPANISH als unterstützte Sprachen erkennt und ENGLISH als Fallback-Sprache verwendet.

Mit dieser Konfiguration kann die Funktion getLocalizedUrl dynamisch lokalisierte URLs basierend auf der Sprachpräferenz des Benutzers generieren:

getLocalizedUrl("/about", Locales.FRENCH); // Ausgabe: "/fr/about"getLocalizedUrl("/about", Locales.SPANISH); // Ausgabe: "/es/about"getLocalizedUrl("/about", Locales.ENGLISH); // Ausgabe: "/about"

Durch die Integration von getLocalizedUrl können Entwickler konsistente URL-Strukturen über mehrere Sprachen hinweg beibehalten, was sowohl die Benutzererfahrung als auch die SEO verbessert.