Автор:
    Aymeric PINEAU
    Создание:2026-09-19Последнее обновление:2026-09-19

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

    Хук useLocale из remix-intlayer предоставляет доступ к локали обрабатываемого в данный момент HTTP-запроса, а также к локали по умолчанию и списку доступных локалей, настроенных в проекте.

    Использование

    В компоненте Remix (например, переключателе языков):

    src/components/LocaleSwitcher.tsx
    import { type FC } from "react";
import { Link } from "@remix-run/react";
import { useLocale } from "remix-intlayer";
import { getLocalizedUrl, getPathWithoutLocale } from "intlayer";

export const LocaleSwitcher: FC = () => {
  const { locale, availableLocales } = useLocale();
  const pathWithoutLocale = getPathWithoutLocale();

  return (
    <nav>
      <ul>
        {availableLocales.map((localeItem) => (
          <li key={localeItem} className="p-1">
            <Link
              href={getLocalizedUrl(pathWithoutLocale, localeItem)}
              aria-current={localeItem === locale ? "page" : undefined}
            >
              {localeItem.toUpperCase()}
            </Link>
          </li>
        ))}
      </ul>
    </nav>
  );
};

    В обработчике маршрута:

    src/server.ts
    import { createRouter } from "remix/router";
import { intlayer, useLocale } from "remix-intlayer";

const router = createRouter({
  middleware: [intlayer()],
});

router.get("/api/locale-info", () => {
  const { locale, defaultLocale, availableLocales } = useLocale();

  return Response.json({
    locale,
    defaultLocale,
    availableLocales,
  });
});

    Возвращаемые значения

    Хук возвращает объект типа UseLocaleResult:

    СвойствоТипОписание
    localeDeclaredLocalesЛокаль, определенная для текущего запроса.
    defaultLocaleDeclaredLocalesРезервная локаль по умолчанию, настроенная в intlayer.config.ts.
    availableLocalesDeclaredLocales[]Массив всех доступных локалей, настроенных в intlayer.config.ts.

    Описание

    1. Определение в рамках запроса: Во время активного запроса, обрабатываемого промежуточным ПО intlayer(), хук useLocale считывает разрешенную локаль из хранилища контекста запроса.
    2. Резервное значение (Fallback): При вызове вне контекста запроса (например, во время скриптов инициализации или выполнения тестов) возвращается настроенная defaultLocale.

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

    useIntlayervite-intlayer