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'.

useLocale es un hook client-side y solo puede usarse en componentes client-side. Asegúrate de que tu app esté envuelta en un <GTProvider>.

Para la gestión de locales en el server-side, consulta getLocale.

Referencia

Devuelve

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


Comportamiento del fallback

Cuando se solicita un locale no compatible, se seleccionará un locale de fallback.

Por ejemplo, en el caso de un locale no compatible, si (1) el usuario ha configurado varios locales preferidos en la configuración del navegador, y (2) uno de esos locales es compatible con tu aplicación, entonces el locale hará fallback al idioma más adecuado.

Además, si no hay locales posibles de fallback disponibles, pero dos locales comparten el mismo idioma (p. ej., en-US y en-GB), entonces el locale hará fallback al locale compatible que comparte ese idioma.

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

Consulta la documentación de gt.config.json 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
"use client";
import { useLocale } from 'gt-next';

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 provider en la raíz.
  • useLocale solo funciona en el cliente.
  • Obtén más información sobre los códigos de configuración regional aquí.

Próximos pasos

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

¿Qué te parece esta guía?