Documentazione: Funzione getMultilingualUrls in intlayer

Descrizione

La funzione getMultilingualUrls genera una mappatura di URL multilingue aggiungendo un prefisso all'URL fornito con ciascuna delle lingue supportate. Può gestire sia URL assoluti che relativi, applicando il prefisso della lingua appropriata in base alla configurazione fornita o ai valori predefiniti.

Parametri

• url: string

  • Descrizione: La stringa URL originale a cui verranno aggiunti i prefissi delle lingue.
  • Tipo: string

• locales: Locales[]

  • Descrizione: Array opzionale delle lingue supportate. Di default utilizza le lingue configurate nel progetto.
  • Tipo: Locales[]
  • Predefinito: localesDefault

• defaultLocale: Locales

  • Descrizione: La lingua predefinita per l'applicazione. Di default utilizza la lingua predefinita configurata nel progetto.
  • Tipo: Locales
  • Predefinito: defaultLocaleDefault

• prefixDefault: boolean

  • Descrizione: Se aggiungere il prefisso per la lingua predefinita. Di default utilizza il valore configurato nel progetto.
  • Tipo: boolean
  • Predefinito: prefixDefaultDefault

Ritorna

• Tipo: IConfigLocales<string>
• Descrizione: Un oggetto che mappa ogni lingua al corrispondente URL multilingue.

Esempio di utilizzo

URL relativi

import { getMultilingualUrls, Locales } from "intlayer";

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

URL assoluti

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

Casi limite

• Nessun segmento di lingua:

  • La funzione rimuove qualsiasi segmento di localizzazione esistente dall'URL prima di generare le mappature multilingue.

• Localizzazione Predefinita:

  • Quando prefixDefault è false, la funzione non aggiunge il prefisso all'URL per la localizzazione predefinita.

• Localizzazioni Non Supportate:

  • Solo le localizzazioni fornite nell'array locales sono considerate per la generazione degli URL.

Utilizzo nelle Applicazioni

In un'applicazione multilingue, configurare le impostazioni di internazionalizzazione con locales e defaultLocale è fondamentale per garantire la visualizzazione della lingua corretta. Di seguito un esempio di come getMultilingualUrls può essere utilizzato nella configurazione di un'applicazione:

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

// Configurazione per le localizzazioni supportate e la localizzazione predefinita
export default {
  internationalization: {
    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
    defaultLocale: Locales.ENGLISH,
  },
} satisfies IntlayerConfig;

export default config;

La configurazione sopra garantisce che l'applicazione riconosca ENGLISH, FRENCH e SPANISH come lingue supportate e utilizzi ENGLISH come lingua di fallback.

Utilizzando questa configurazione, la funzione getMultilingualUrls può generare dinamicamente mappature di URL multilingue basate sulle localizzazioni supportate dall'applicazione:

getMultilingualUrls(
  "/dashboard",
  [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
  Locales.ENGLISH
);
// Output:
// {
//   en: "/dashboard",
//   fr: "/fr/dashboard",
//   es: "/es/dashboard"
// }

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

Integrando getMultilingualUrls, gli sviluppatori possono mantenere strutture URL coerenti attraverso più lingue, migliorando sia l'esperienza utente che la SEO.