Dokumentation: getMultilingualUrls Funktion in intlayer

Beschreibung

Die Funktion getMultilingualUrls erzeugt eine Zuordnung mehrsprachiger URLs, indem sie die gegebene URL mit jedem unterstützten Gebietsschema (Locale) voranstellt. Sie kann sowohl absolute als auch relative URLs verarbeiten und wendet das entsprechende Gebietsschema-Präfix basierend auf der bereitgestellten Konfiguration oder den Standardwerten an.

Parameter

• url: string

  • Beschreibung: Der ursprüngliche URL-String, der mit Gebietsschemata vorangestellt werden soll.
  • Typ: string

• locales: Locales[]

  • Beschreibung: Optionale Liste der unterstützten Gebietsschemata. Standardmäßig die im Projekt konfigurierten Gebietsschemata.
  • Typ: Locales[]
  • Standard: localesDefault

• defaultLocale: Locales

  • Beschreibung: Das Standardgebietsschema für die Anwendung. Standardmäßig das im Projekt konfigurierte Standardgebietsschema.
  • Typ: Locales
  • Standard: defaultLocaleDefault

• prefixDefault: boolean

  • Beschreibung: Ob das Standard-Gebietsschema vorangestellt werden soll. Standardmäßig der im Projekt konfigurierte Wert.
  • Typ: boolean
  • Standard: prefixDefaultDefault

Rückgabewert

• Typ: IConfigLocales<string>
• Beschreibung: Ein Objekt, das jedes Gebietsschema seiner entsprechenden mehrsprachigen URL zuordnet.

Beispielhafte Verwendung

Relative URLs

import { getMultilingualUrls, Locales } from "intlayer";

getMultilingualUrls(
  "/dashboard",
  [Locales.ENGLISH, Locales.FRENCH],
  Locales.ENGLISH,
  false
);
// Ausgabe: {
//   en: "/dashboard",
//   fr: "/fr/dashboard"
// }

Absolute URLs

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

Randfälle

• Kein Gebietsschema-Segment:

  • Die Funktion entfernt jeglichen vorhandenen Sprachabschnitt aus der URL, bevor die mehrsprachigen Zuordnungen generiert werden.

• Standard-Sprache:

  • Wenn prefixDefault auf false gesetzt ist, wird die URL für die Standardsprache nicht mit einem Präfix versehen.

• Nicht unterstützte Sprachen:

  • Es werden nur die Sprachen berücksichtigt, die im locales-Array angegeben sind, um die URLs zu generieren.

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. Nachfolgend ein Beispiel, wie getMultilingualUrls in einer Anwendungs-Konfiguration verwendet werden kann:

import { Locales, type IntlayerConfig } from "intlayer";

// Konfiguration für unterstützte Sprachen und Standardsprache
export 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 ENGLISCH, FRANZÖSISCH und SPANISCH als unterstützte Sprachen erkennt und ENGLISCH als Fallback-Sprache verwendet.

Mit dieser Konfiguration kann die Funktion getMultilingualUrls dynamisch mehrsprachige URL-Zuordnungen basierend auf den unterstützten Sprachen der Anwendung generieren:

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

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