Helpers

useLocale

Referencia de API del hook useLocale

Descripción general

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

useLocale es un hook del lado del cliente y solo puede usarse en componentes del lado del cliente. Asegúrate de envolver tu aplicación en un <GTProvider>.

Para la gestión del locale del lado del servidor, consulta getLocale.

Referencias

Devuelve

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


Comportamiento del 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 esos locales es compatible con tu aplicación, entonces el locale usará el mejor idioma disponible.

Además, si no hay locales de respaldo posibles, 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 la documentación de gt.config.json para obtener información sobre cómo configurar los locales compatibles.


Ejemplos

Uso básico

Obtén la locale actual y muéstrala 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 proveedor en el nivel raíz.
  • useLocale funciona únicamente 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 admitidos en tu aplicación con el archivo gt.config.json.

¿Qué te ha parecido esta guía?

useLocale