Autor:
    Aymeric PINEAU
    Erstellung:2026-09-19Letzte Aktualisierung:2026-09-19

    useLocale Hook Dokumentation

    Der useLocale-Hook aus astro-intlayer bietet Zugriff auf das aktuelle Anfrage-Locale, das konfigurierte Standard-Locale und alle verfügbaren Locales in Astro-Anwendungen.

    Er verhält sich im serverseitig gerenderten .astro-Frontmatter und in clientseitigen <script>-Blöcken konsistent.

    Verwendung

    Im Komponenten-Frontmatter (Serverseitig gerendert)

    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>Aktuell: {locale}</span>
      <span>Standard: {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>

    Im Client-<script> (Interaktiv)

    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>

    Rückgabewerte

    Der Hook gibt ein Objekt vom Typ UseLocaleResult zurück:

    EigenschaftTypBeschreibung
    localeDeclaredLocalesDas aktive Locale.
    defaultLocaleDeclaredLocalesDas in intlayer.config.ts konfigurierte Standard-Fallback-Locale.
    availableLocalesDeclaredLocales[]Array aller für das Projekt konfigurierten unterstützten Locales.
    setLocale(locale: LocalesValues) => voidFunktion zur Aktualisierung des Locales. (Interaktiv im <script>, warnt während SSR).
    subscribe(callback: () => void) => () => voidAbonniert clientseitige Locale-Änderungen.

    Server- vs. Client-Verhalten

    • Während SSR / Server-Rendering: Eine Anfrage wird einmal mit festen Parametern gerendert. Das Aufrufen von setLocale() während eines Server-Renderings hat keine Auswirkung und gibt eine Warnung aus; der Wechsel des Locales sollte auf dem Client oder durch Navigation zur Ziel-Locale-URL erfolgen.
    • In Client-Skripten: setLocale aktualisiert den Client-Store sowie persistierte Cookies oder den lokalen Speicher gemäß Ihrer Intlayer-Konfiguration.

    Zugehörige Dokumentation

    useIntlayerremix-intlayer