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

Хук useIntlayer дозволяє отримувати локалізований контент зі словника Intlayer за ключем у додатках Remix 3.

Він автоматично зчитує активну локаль із контексту поточного запиту (через AsyncLocalStorage), тому вам не потрібно передавати локаль через обробники маршрутів, шаблони представлень або компоненти.

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

В обробниках маршрутів

import { createRouter } from "remix/router";
import { intlayer, useIntlayer } from "remix-intlayer";

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

router.get("/api/welcome", () => {
  const content = useIntlayer("home");

  return Response.json({
    title: content.title,
    subtitle: content.subtitle,
  });
});

У шаблонах представлень та компонентах

import { useIntlayer } from "remix-intlayer";

export const HomeView = () => {
  const content = useIntlayer("home");

  return `
    <main>
      <h1>${content.title}</h1>
      <p>${content.subtitle}</p>
    </main>
  `;
};

Параметри

useIntlayer(key, localeOrSelector?)

1. key: Унікальний ключ словника (як визначено у ваших файлах оголошень .content.ts).
2. localeOrSelector (необов'язково): Конкретна локаль або об'єкт селектора ({ item }, { variant }, необов'язково з locale). Якщо вказано, він перевизначає локаль, визначену з контексту запиту.

Опис

Хук виконує такі завдання:

1. Визначення локалі з контексту: Визначає поточну локаль з області AsyncLocalStorage, прив'язаної до запиту middleware intlayer().
2. Отримання словника: Отримує попередньо скомпільований словник, що відповідає наданому ключу.
3. Обробка перекладів: Обчислює переклади, перелічення, markdown та умовний контент для визначеної локалі.
4. Обробка Fallback: Якщо викликається поза контекстом активного HTTP-запиту (наприклад, фонові завдання або модульні тести без middleware), він безпечно повертається до налаштованої defaultLocale.

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

• Middleware intlayer
• Хук useDictionary
• Хук useLocale