Config

loadDictionary

Referencia de API de la función loadDictionary().

Descripción general

loadDictionary cargará un archivo JSON de traducciones para un locale dado.

Esta función está pensada para quienes desean usar gt-next como una biblioteca de i18n independiente.

Esta función se utiliza principalmente para migrar proyectos existentes con i18n a General Translation manteniendo sus traducciones actuales. Sigue esta guía para configurarlo.

Si existen varias traducciones, las traducciones de los diccionarios cargados por loadDictionary siempre tendrán prioridad sobre las demás. loadDictionary solo admite el uso de files JSON con traducciones de tipo string.

Referencia

Parámetros

Prop

Type

Descripción

TipoDescripción
localeEl locale para el que se deben cargar las traducciones.

Devuelve

Una Promise<any> que se resuelve en un diccionario que mapea id a traducciones para el locale indicado.


Configuración

Por lo general, cargarás el diccionario desde el directorio ./public/locales.

Define loadDictionary como la exportación predeterminada de un archivo con el nombre loadDictionary.js o loadDictionary.ts, ya sea en el directorio src/ o en la raíz. Asegúrate de que la función devuelva una promesa que se resuelva en un objeto con las traducciones para el locale dado.

src/loadDictionary.js
export default async function loadDictionary(locale) {
  const translations = await import(`../public/locales/${locale}.json`);
  return translations.default;
}

Pregunta: ¿Cuál es la diferencia entre loadTranslations y loadDictionary?

  • loadTranslations se usa para definir un comportamiento de carga personalizado para obtener las traducciones de tu app. Esto puede ser desde una CDN (red de distribución de contenidos), una base de datos o el bundle de tu app. Suelen ser traducciones generadas por máquina, gestionadas por la herramienta de la CLI (interfaz de línea de comandos) y no son muy prácticas de editar.
  • loadDictionary está pensado para implementaciones de gt-next como biblioteca independiente. Los usuarios aportan sus propias traducciones y no se utiliza infraestructura de traducción.

Notas

  • loadDictionary se utiliza para cargar traducciones personalizadas para tu app.
  • Los diccionarios cargados con loadDictionary tendrán prioridad sobre las traducciones cargadas por loadTranslations.

Próximos pasos

¿Qué te parece esta guía?