useLocale()

Descripción general

El hook useLocale obtiene 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'.

Para la gestión de la configuración regional en el lado del servidor, consulta getLocale().

Referencia

Devuelve

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

Comportamiento de reserva

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

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

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

Si no se cumple ninguna de estas condiciones, se utilizará la configuración regional predeterminada.

Consulta la documentación de gt.config.json para obtener información sobre cómo configurar las configuraciones regionales compatibles.

Ejemplos

Uso Básico

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

"use client";
import { useLocale } from 'gt-next/client';

export default function CurrentLocale() {
    const locale = useLocale(); 
    return <p>Current locale: {locale}</p>;
}

Notas

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

Próximos pasos

• Aprende cómo gestionar y especificar los idiomas compatibles en tu aplicación con el archivo gt.config.json.
• Para acceder al idioma de respaldo, consulta useDefaultLocale().