Helpers

useLocale()

Referencia de API para el hook useLocale

Resumen

El hook useLocale recupera la configuración regional actual del usuario desde el contexto de <GTProvider>. La configuración regional devuelta está formateada como una cadena, por ejemplo, 'en-US'.

Asegúrate de que tu aplicación esté envuelta en un <GTProvider>.

Referencia

Devuelve

Una cadena que representa la configuración regional actual del usuario, por ejemplo, 'en-US'.


Comportamiento de respaldo

Cuando se solicita una configuración regional no compatible, se seleccionará una configuración regional de respaldo.

Por ejemplo, en el caso de una configuración regional no compatible, si (1) el usuario ha configurado múltiples configuraciones regionales preferidas en la configuración de su navegador, y (2) una de estas configuraciones regionales es compatible con su aplicación, entonces la configuración regional recurrirá al mejor idioma.

Además, si no hay configuraciones regionales de respaldo posibles disponibles, pero dos configuraciones regionales comparten el mismo idioma (por ejemplo, en-US y en-GB), entonces la configuración regional recurrirá a la configuración regional compatible que comparte el mismo idioma.

Si no se puede cumplir ninguna de las condiciones, entonces se usará la configuración regional predeterminada.

Consulte <GTProvider> para obtener información sobre cómo configurar configuraciones regionales compatibles.


Ejemplos

Uso Básico

Recupera la configuración regional actual y muéstrala en tu componente.

CurrentLocale.jsx
import { useLocale } from 'gt-react';
 
export default function CurrentLocale() {
    const locale = useLocale(); 
    return <p>Current locale: {locale}</p>;
}

Notas

  • El hook useLocale() depende del <GTProvider> para acceder al contexto. Asegúrate de que tu aplicación esté envuelta con un proveedor en el nivel raíz.
  • Aprende más sobre cadenas de locales aquí.

Próximos Pasos

En esta página