Автор:
    Дата створення:2026-09-19Останнє оновлення:2026-09-19

    Документація хука useLocale

    Хук useLocale з astro-intlayer надає доступ до поточної локалі запиту, налаштованої локалі за замовчуванням та всіх доступних локалей у додатках Astro.

    Він працює однаково як у frontmatter компонентів .astro, що рендеряться на сервері, так і в клієнтських блоках <script>.

    Використання

    У Frontmatter компонента (рендер на сервері)

    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>Поточна: {locale}</span>
          <span>За замовчуванням: {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>
    

    У клієнтському <script> (інтерактивність)

    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>
    

    Значення, що повертаються

    Хук повертає об'єкт типу UseLocaleResult:

    ВластивістьТипОпис
    localeDeclaredLocalesАктивна локаль.
    defaultLocaleDeclaredLocalesЛокаль за замовчуванням, налаштована в intlayer.config.ts.
    availableLocalesDeclaredLocales[]Масив усіх підтримуваних локалей, налаштованих для проекту.
    setLocale(locale: LocalesValues) => voidФункція для оновлення локалі. (Інтерактивна в клієнтському <script>, виводить попередження під час SSR).
    subscribe(callback: () => void) => () => voidПідписується на зміни локалі на стороні клієнта.

    Поведінка на сервері та на клієнті

    • Під час SSR / рендерингу на сервері: Запит рендериться один раз із фіксованими параметрами. Виклик setLocale() під час рендерингу на сервері не діє і виводить попередження; перемикання локалей слід виконувати на клієнті або шляхом переходу за потрібною локалізованою URL-адресою.
    • У клієнтських скриптах: setLocale оновлює клієнтське сховище та оновлює збережені кукі або локальне сховище відповідно до вашої конфігурації Intlayer.

    Пов'язана документація