Helpers

useDefaultLocale()

Referencia de API para el hook useDefaultLocale

Descripción general

El hook useDefaultLocale recupera la configuración regional predeterminada de la aplicación desde el contexto de <GTProvider>. Esta configuración regional representa el idioma de respaldo para tu aplicación y normalmente se utiliza cuando la configuración regional preferida por el usuario no está disponible.

useDefaultLocale es un hook del lado del cliente y solo puede usarse en componentes del lado del cliente. Asegúrate de que tu aplicación esté envuelta en un <GTProvider>.

Consulta withGTConfig() para la configuración. Si no se especifica una configuración regional predeterminada en withGTConfig(), el valor predeterminado es 'en-US'. Para el lado del servidor, consulta getDefaultLocale().

Referencia

Devuelve

Una cadena que representa la configuración regional predeterminada de la aplicación, por ejemplo, 'en-US'.


Ejemplos

Uso básico

Recupera la configuración regional predeterminada de la aplicación y muéstrala en tu componente.

DefaultLocale.jsx
"use client";
import { useDefaultLocale } from 'gt-next/client';

export default function DefaultLocale() {
    const defaultLocale = useDefaultLocale();

    return <p>Default locale: {defaultLocale}</p>; // Display the default locale
}

Notas

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

Próximos pasos

  • Consulta useLocale y getLocale para obtener la configuración regional del usuario.
  • Explora getDefaultLocale() para obtener la configuración regional predeterminada en los componentes del servidor.

¿Qué te parece esta guía?