getLocale()

Resumen

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

Para uso del lado del cliente, consulte 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 respaldo

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

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

Además, si no hay configuraciones regionales de respaldo posibles disponibles, 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 regional compatible que comparte el mismo idioma.

Si no se puede cumplir ninguna de las condiciones, entonces se usará la configuración regional predeterminada.

Consulte la guía de gestión de configuraciones regionales() para obtener información sobre cómo configurar configuraciones regionales compatibles.

Ejemplos

Uso Básico

Recuperar 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 asincrónica y debe ser esperada para recuperar la configuración regional.
• Está diseñada específicamente para uso del lado del servidor. Consulte useLocale() para componentes del lado del cliente.
• La configuración regional devuelta se adhiere al formato de cadenas de configuración regional.

Próximos Pasos

• Aprende cómo configurar locales compatibles con Configuración de i18n.
• Para gestionar locales de respaldo, consulta getDefaultLocale().