Автор:
    Создание: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 обновляет клиентское хранилище и сохраняет файлы cookie или данные в локальном хранилище в соответствии с конфигурацией Intlayer.

    Связанная документация