Autor:
    Data utworzenia:2026-09-19Ostatnia aktualizacja:2026-09-19

    Dokumentacja hooka useLocale

    Hook useLocale z pakietu astro-intlayer zapewnia dostęp do aktualnej lokalizacji zapytania, skonfigurowanej domyślnej lokalizacji oraz wszystkich dostępnych lokalizacji w aplikacjach Astro.

    Działa spójnie zarówno w sekcji frontmatter komponentów .astro renderowanych na serwerze, jak i w blokach skryptów klienta <script>.

    Użycie

    W sekcji frontmatter komponentu (renderowanie na serwerze)

    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>Bieżący: {locale}</span>
          <span>Domyślny: {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>
    

    W skrypcie klienta <script> (interaktywność)

    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>
    

    Zwracane wartości

    Hook zwraca obiekt typu UseLocaleResult:

    WłaściwośćTypOpis
    localeDeclaredLocalesAktywna lokalizacja.
    defaultLocaleDeclaredLocalesDomyślna lokalizacja rezerwowa skonfigurowana w intlayer.config.ts.
    availableLocalesDeclaredLocales[]Tablica wszystkich obsługiwanych lokalizacji skonfigurowanych w projekcie.
    setLocale(locale: LocalesValues) => voidFunkcja do aktualizacji lokalizacji. (Interaktywna w <script> klienta, wyświetla ostrzeżenie podczas SSR).
    subscribe(callback: () => void) => () => voidSubskrybuje zmiany lokalizacji po stronie klienta.

    Zachowanie na serwerze a na kliencie

    • Podczas SSR / renderowania na serwerze: Zapytanie jest renderowane jednokrotnie ze stałymi parametrami. Wywołanie setLocale() podczas renderowania na serwerze nie przynosi efektu i generuje ostrzeżenie; przełączanie lokalizacji powinno odbywać się po stronie klienta lub poprzez przejście pod adres URL z odpowiednią lokalizacją.
    • W skryptach klienta: setLocale aktualizuje magazyn klienta oraz zapisane ciasteczka lub pamięć lokalną zgodnie z konfiguracją Intlayer.

    Powiązana dokumentacja