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-react como una biblioteca de i18n independiente.

Esta función se usa principalmente para migrar proyectos existentes con i18n a General Translation manteniendo sus traducciones actuales.

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

Referencias

Parámetros

Prop

Type

Descripción

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

Devoluciones

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


Configuración

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

Define tu loadDictionary en un archivo. Asegúrate de que la función devuelva una promesa que se resuelva en un objeto con las traducciones para el locale indicado.

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

Luego pásalo a tu componente <GTProvider>:

src/App.js
import { GTProvider } from 'gt-react';
import loadDictionary from './loadDictionary';

<GTProvider loadDictionary={loadDictionary}>
  <App />
</GTProvider>

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

  • loadTranslations se usa para definir un comportamiento de carga personalizado para obtener traducciones para tu app. Esto puede implicar obtener traducciones desde una red de distribución de contenido (CDN), una base de datos o el bundle de tu app. Por lo general, son traducciones generadas automáticamente, gestionadas por la herramienta de la CLI, y no son muy amigables de editar para los usuarios.
  • loadDictionary está pensado para implementaciones de gt-react como biblioteca independiente. Los usuarios aportan sus propias traducciones y no se utiliza ninguna infraestructura de traducción.

Notas

  • loadDictionary se usa para cargar traducciones personalizadas de tu aplicación.
  • Los diccionarios cargados con loadDictionary tendrán prioridad sobre las traducciones cargadas por loadTranslations.

Próximos pasos

¿Qué te parece esta guía?