Helpers

useLocale

Referencia de API del hook useLocale

Descripción general

El hook useLocale obtiene el locale actual del usuario del contexto de <GTProvider>. El locale devuelto se formatea como una cadena, p. ej., 'en-US'.

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

Referencias

Devuelve

Una cadena que representa el locale actual del usuario, p. ej., 'en-US'.


Comportamiento de contenido de respaldo predeterminado

Cuando se solicite un locale no compatible, se seleccionará un locale de respaldo.

Por ejemplo, en el caso de un locale no compatible, si (1) el usuario ha configurado varios locales preferidos en la configuración de su navegador, y (2) uno de estos locales es compatible con tu aplicación, entonces el locale recurrirá al mejor idioma disponible.

Además, si no hay locales de respaldo disponibles, pero dos locales comparten el mismo idioma (p. ej., en-US y en-GB), entonces el locale recurrirá al locale compatible que comparta el mismo idioma.

Si no se cumple ninguna de las condiciones, se utilizará el locale predeterminado.

Consulta <GTProvider> para obtener información sobre cómo configurar los locales compatibles.


Ejemplos

Uso básico

Obtén el locale actual y muéstralo en tu componente.

CurrentLocale.jsx
import { useLocale } from 'gt-react';

export default function CurrentLocale() {
    const locale = useLocale(); 
    return <p>Configuración regional actual: {locale}</p>;
}

Notas

  • El hook useLocale depende de <GTProvider> para acceder al contexto. Asegúrate de envolver tu aplicación con un proveedor en el nivel raíz.
  • Obtén más información sobre los códigos de configuración regional aquí.

Próximos pasos

  • Aprende a gestionar y especificar las locales compatibles en tu aplicación con el archivo gt.config.json.

¿Qué te ha parecido esta guía?

useLocale