getLocale()

Descripción general

La función getLocale() recupera la configuración regional actual del usuario durante el renderizado del lado del servidor. La configuración regional devuelta está formateada como una cadena, por ejemplo, 'en-US'.

Para uso en el lado del cliente, consulta useLocale().

Referencia

Devuelve

Una promesa que se resuelve en 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 caso de una configuración regional no compatible, si (1) el usuario ha configurado varios idiomas preferidos en la configuración de su navegador, y (2) uno de estos idiomas 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 del usuario durante la renderización del lado del servidor.

import getLocale from 'gt-next/server';

export default async function GetUserLocale() {
    const locale = await getLocale(); 
    return <p>User locale: {locale}</p>;
}

Notas

• La función getLocale() es asíncrona y debe ser utilizada con await para obtener la configuración regional.
• Está diseñada específicamente para su uso en el lado del servidor. Consulta useLocale() para componentes del lado del cliente.
• La configuración regional devuelta sigue el formato de cadenas de configuración regional.

Próximos pasos

• Aprende cómo configurar los idiomas compatibles con withGTConfig().
• Para gestionar los idiomas de respaldo, consulta getDefaultLocale().