Descripción general

La función getLocale obtiene el locale actual del usuario durante el renderizado en el servidor. El locale devuelto está formateado como una cadena, p. ej., 'en-US'.

Para uso en el cliente, consulta useLocale.

Referencias

Devuelve

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

Comportamiento del contenido de respaldo predeterminado

Cuando se solicita 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) alguno de esos 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 ese mismo idioma.

Si no se cumple ninguna de las condiciones, se usará 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 del usuario durante el renderizado del lado del servidor.

import { getLocale } from 'gt-next/server';

export default async function GetUserLocale() {
    const locale = await getLocale(); 
    return <p>Configuración regional del usuario: {locale}</p>;
}

Notas

• La función getLocale es asíncrona y debe esperarse (await) para obtener el locale.
• Está diseñada específicamente para uso del lado del servidor. Consulta useLocale para componentes del lado del cliente.
• El locale devuelto cumple el formato de códigos de configuración regional.

Próximos pasos

• Aprende a configurar las locales admitidas con withGTConfig().