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 lado del 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 de contenido de respaldo predeterminado

Cuando se solicita un locale no admitido, se seleccionará un locale de contenido de respaldo predeterminado.

Por ejemplo, en el caso de un locale no admitido, si (1) el usuario ha configurado varios locales preferidos en la configuración de su navegador y (2) uno de esos locales es admitido por tu aplicación, entonces el locale recurrirá al mejor idioma como contenido de respaldo predeterminado.

Además, si no hay locales posibles de contenido de respaldo predeterminado disponibles, pero dos locales comparten el mismo idioma (p. ej., en-US y en-GB), entonces el locale recurrirá al locale admitido 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 admitidos.

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>Locale del usuario: {locale}</p>;
}

Notas

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

Próximos pasos

• Aprende a configurar los locales compatibles con withGTConfig().