Autor:
    Aymeric PINEAU
    Creación:2026-09-19Última actualización:2026-09-19

    Documentación del hook useLocale

    El hook useLocale de astro-intlayer proporciona acceso al locale de solicitud actual, al locale predeterminado configurado y a todos los locales disponibles en aplicaciones Astro.

    Se comporta de manera consistente en el frontmatter de .astro renderizado en el servidor y en los bloques <script> del lado del cliente.

    Uso

    En el Frontmatter de componentes (Renderizado en Servidor)

    src/layouts/Layout.astro
    ---
import { useLocale } from "astro-intlayer";
import { getLocalizedUrl, getPathWithoutLocale } from "intlayer";

const { locale, defaultLocale, availableLocales } = useLocale();
const pathWithoutLocale = getPathWithoutLocale(Astro.url.pathname);
---

<!DOCTYPE html>
<html lang={locale}>
  <head>
    <meta charset="utf-8" />
    <title>Astro + Intlayer</title>
  </head>
  <body>
    <header>
      <span>Actual: {locale}</span>
      <span>Predeterminado: {defaultLocale}</span>
      <nav>
        <ul>
          {availableLocales.map((localeItem) => (
            <li key={localeItem} className="p-1">
              <a
                href={getLocalizedUrl(pathWithoutLocale, localeItem)}
                aria-current={localeItem === locale ? "page" : undefined}
              >
                {localeItem.toUpperCase()}
              </a>
            </li>
          ))}
        </ul>
      </nav>
    </header>
    <slot />
  </body>
</html>

    En <script> del cliente (Interactivo)

    src/components/LocaleSwitcher.astro
    ---
import { useLocale } from "astro-intlayer";

const { locale, availableLocales } = useLocale();
---

<select id="locale-select">
  {availableLocales.map((loc) => (
    <option value={loc} selected={loc === locale}>
      {loc.toUpperCase()}
    </option>
  ))}
</select>

<script>
  import { useLocale, setLocaleInStorage } from "astro-intlayer";

  const { setLocale } = useLocale();

  document.getElementById("locale-select")?.addEventListener("change", (e) => {
    const target = e.target as HTMLSelectElement;
    setLocale(target.value);
  });
</script>

    Valores de retorno

    El hook devuelve un objeto de tipo UseLocaleResult:

    PropiedadTipoDescripción
    localeDeclaredLocalesEl locale activo.
    defaultLocaleDeclaredLocalesEl locale de respaldo predeterminado configurado en intlayer.config.ts.
    availableLocalesDeclaredLocales[]Matriz de todos los locales admitidos configurados para el proyecto.
    setLocale(locale: LocalesValues) => voidFunción para actualizar el locale. (Interactiva en <script>, advierte durante SSR).
    subscribe(callback: () => void) => () => voidSe suscribe a los cambios de locale en el lado del cliente.

    Comportamiento Servidor vs Cliente

    • Durante SSR / Renderizado en Servidor: Una solicitud se procesa una vez con parámetros fijos. Llamar a setLocale() durante un renderizado de servidor no tiene efecto y emite una advertencia; el cambio de locale debe realizarse en el cliente o navegando a la URL del locale de destino.
    • En scripts de cliente: setLocale actualiza el store del cliente y actualiza las cookies persistidas o el almacenamiento local de acuerdo con tu configuración de Intlayer.

    Documentación relacionada

    useIntlayerremix-intlayer