Config

loadDictionary()

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

Descripción general

loadDictionary() cargará un archivo json de traducción para un idioma determinado.

Esta función está destinada a aquellos que desean utilizar gt-react como una biblioteca i18n independiente.

Esta función se utiliza principalmente para migrar proyectos existentes con i18n a General Translation mientras se mantienen sus traducciones existentes.

Si existen múltiples traducciones, las traducciones de los diccionarios cargados por loadDictionary() siempre tendrán prioridad sobre las demás. loadDictionary() solo admite el uso de archivos JSON con traducciones de cadenas de texto.

Referencia

Parámetros

PropTypeDefault
locale?
string
-

Descripción

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

Retorna

Un Promise<any> que se resuelve en un diccionario que mapea ids a traducciones para el locale dado.


Configuración

Generalmente, cargarás el diccionario desde el directorio ./public/locales.

Define tu función loadDictionary() en un archivo. Asegúrate de que la función devuelva una promesa que se resuelva en un objeto con traducciones para el idioma especificado.

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 utiliza para definir un comportamiento de carga personalizado para obtener traducciones para tu aplicación. Esto podría ser obtener traducciones desde un CDN, una base de datos o el paquete de tu aplicación. Estas son generalmente traducciones generadas por máquina, gestionadas por la herramienta CLI, y no son muy fáciles de editar para los usuarios.
  • loadDictionary() está destinado a implementaciones de gt-react 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 aplicación.
  • Los diccionarios cargados por loadDictionary() tendrán prioridad sobre las traducciones cargadas por loadTranslations().

Próximos pasos

En esta página