Автор:
    Дата створення:2026-06-12Останнє оновлення:2026-08-04

    Варіанти

    Варіант — це набір файлів контенту, що мають спільний ключ словника (key), але кожен несе своє значення variant. Intlayer віддає відповідний файл на основі селектора, переданого до useIntlayer.

    Значення variant може набувати двох форм:

    • Рядок — одна іменована альтернатива (A/B-тести, сезонні банери, feature-прапорці).
    • Об'єкт — структурований дискримінатор, адресований набором полів (записи CMS, контент конкретного користувача, будь-який контент із непрозорим ID як ключем). Ідентичністю є весь об'єкт: селектор має надати рівний об'єкт, щоб розв'язати запис.
    Об'єктна форма замінює колишнє поле meta. Усюди, де раніше ви писали meta: { id, … }, пишіть variant: { id, … } і вибирайте її через { variant: { id, … } }.

    Іменовані (рядкові) варіанти

    Кожен файл представляє одну іменовану альтернативу. Пропуск variant (або значення "default") позначає його як запасний.

    hero-banner.content.ts
    import { t, type Dictionary } from "intlayer";
    
    const dictionary = {
      key: "hero-banner",
      variant: "default",
      content: {
        headline: t({
          en: "Build faster with Intlayer",
          fr: "Développez plus vite avec Intlayer",
        }),
        cta: t({ en: "Get started", fr: "Commencer" }),
      },
    } satisfies Dictionary;
    
    export default dictionary;
    hero-banner.black-friday.content.ts
    import { t, type Dictionary } from "intlayer";
    
    const dictionary = {
      key: "hero-banner",
      variant: "black_friday",
      content: {
        headline: t({
          en: "50 % off — today only",
          fr: "−50 % — aujourd'hui seulement",
        }),
        cta: t({ en: "Shop now", fr: "Acheter maintenant" }),
      },
    } satisfies Dictionary;
    
    export default dictionary;

    Часткові варіанти

    Варіант оголошує лише ключі, які він перевизначає; решта успадковується з запису за замовчуванням.

    hero-banner.summer.content.ts
    import { t, type Dictionary } from "intlayer";
    
    const dictionary = {
      key: "hero-banner",
      variant: "summer",
      content: {
        headline: t({
          en: "Build faster all summer",
          fr: "Développez plus vite tout l'été",
        }),
      },
    } satisfies Dictionary;
    
    export default dictionary;
    tsx
    useIntlayer("hero-banner", { variant: "summer" });// → { headline: "Développez plus vite tout l'été", cta: "Commencer" } — `cta` успадкованоuseIntlayer("hero-banner", { variant: "never-declared" });// → запис за замовчуванням

    Тому ви додаєте файл варіанту лише там, де текст дійсно відрізняється. Ключ дозволяється в null тільки в тому випадку, якщо він оголошує варіанти, але не має запису за замовчуванням.

    Використання іменованих варіантів

    Варіант за замовчуванням

    Hero.tsx
    import { useIntlayer } from "react-intlayer";
    
    export const Hero = () => {
      const { headline, cta } = useIntlayer("hero-banner");
      // → варіант за замовчуванням
    
      return (
        <section>
          <h1>{headline}</h1>
          <a>{cta}</a>
        </section>
      );
    };

    Іменований варіант

    tsx
    const { headline, cta } = useIntlayer("hero-banner", {  variant: "black_friday",});

    Іменований варіант із явною локаллю

    tsx
    const content = useIntlayer("hero-banner", {  variant: "black_friday",  locale: "fr",});

    Об'єктні (структуровані) варіанти

    Об'єктний варіант адресує контент довільним набором пар ключ-значення, оголошених у полі variant, — що дозволяє моделювати записи CMS, контент конкретного користувача або будь-який контент із непрозорим ID як ключем. Ідентичністю є весь об'єкт: селектор має надати рівний об'єкт, щоб запис було розв'язано.

    product.abc.content.ts
    import { t, type Dictionary } from "intlayer";
    
    const dictionary = {
      key: "product",
      variant: { id: "prod_abc", userId: "user_123" },
      content: {
        name: t({ en: "Widget Pro", fr: "Widget Pro" }),
        description: t({ en: "The best widget.", fr: "Le meilleur widget." }),
      },
    } satisfies Dictionary;
    
    export default dictionary;
    product.abcd.content.ts
    import { t, type Dictionary } from "intlayer";
    
    const dictionary = {
      key: "product",
      variant: { id: "prod_abcd", userId: "user_123" },
      content: {
        name: t({ en: "Widget Lite", fr: "Widget Lite" }),
        description: t({ en: "A lighter option.", fr: "Une option plus légère." }),
      },
    } satisfies Dictionary;
    
    export default dictionary;

    Використання об'єктних варіантів

    Передайте відповідний об'єкт у variant. Кожне поле, оголошене у словнику, має бути надане й рівне; інакше результат — null. Порядок полів не має значення.

    Product.tsx
    import { useIntlayer } from "react-intlayer";
    
    export const Product = ({
      productId,
      userId,
    }: {
      productId: string;
      userId: string;
    }) => {
      const content = useIntlayer("product", {
        variant: { id: productId, userId },
      });
    
      if (!content) return null;
    
      return <p>{content.description}</p>;
    };

    З явною локаллю

    tsx
    const content = useIntlayer("product", {  variant: { id: "prod_abc", userId: "user_123" },  locale: "fr",});

    Відсутнє поле — немає збігу

    ts
    // Повертає null: відсутній `userId`, тож об'єкт не збігається з оголошеним варіантомconst content = useIntlayer("product", { variant: { id: "prod_abc" } });

    Зовнішній варіант

    Деякі виміри варіанта незмінні протягом усієї сесії — орендар, тип навчального закладу, тарифний рівень. Вони визначаються один раз, і жоден компонент не має передавати їх вручну.

    Не загортайте useIntlayer у власний хук, щоб їх підставити. Оптимізація під час збірки переписує лише літеральний виклик useIntlayer("key"), імпортований з пакета фреймворку, тож ніщо за обгорткою не потрапить до бандла.

    Натомість оголосіть варіант один раз на провайдері, так само як locale:

    App.tsx
    import { IntlayerProvider } from "react-intlayer";
    
    export const App = ({ locale, schoolType }) => (
      <IntlayerProvider locale={locale} variant={schoolType}>
        <Hero />
      </IntlayerProvider>
    );

    Тепер кожне читання словника під провайдером розв'язується з цим варіантом, а селектор у місці виклику завжди перемагає:

    tsx
    useIntlayer("hero-banner");// → варіант провайдераuseIntlayer("hero-banner", { variant: "summer" });// → "summer" — замінює варіант провайдера, а не доповнює його

    Форми

    Проп variant приймає три форми:

    Форма Значення
    variant="school1" один іменований варіант для всіх ключів
    variant={["school1", "default"]} упорядкований ланцюжок переваг
    variant={{ "hero-banner": "school1", default: "base" }} свій варіант для кожного ключа словника

    Ланцюжок переваг

    Ланцюжок перебирається зліва направо за записами, які оголошує кожен ключ, і перемагає перший оголошений. Якщо не оголошено жодного, використовується неявний запис за замовчуванням — так само, як для одиничного значення.

    tsx
    <IntlayerProvider variant={["school1", "school2"]} />// `hero-banner` не оголошує запис `school1`, але оголошує `school2` → "school2"// ключ, що не оголошує жодного з них → запис за замовчуванням

    Отже, ["black_friday", "summer"] читається як «black friday, якщо цей ключ його має, інакше summer, інакше за замовчуванням». Ланцюжки також приймаються в місці виклику:

    tsx
    useIntlayer("hero-banner", { variant: ["black_friday", "summer"] });
    Зверніть увагу: це дзеркальне відображення масиву, який приймає поле variant файлу контенту: там масив оголошує по одному запису на елемент, тут він споживає їх у порядку пріоритету.

    Відображення за ключами

    Звертайтеся до кожного ключа словника окремо. Зарезервований запис default покриває всі неперелічені ключі:

    tsx
    <IntlayerProvider  variant={{    "hero-banner": "school1",    product: ["school1", "default"],    default: "base",  }}/>
    На провайдері звичайний об'єкт завжди читається як відображення за ключами, а не як об'єктний варіант — вони структурно ідентичні. Щоб задати об'єктний варіант глобально, вкладіть його в запис: variant={{ default: { id: "prod_abc" } }}.

    Оскільки ключі відображення звіряються з оголошеними ключами словників, друкарська помилка — або об'єктний варіант, записаний напряму, як-от variant={{ id: "prod_abc" }} — призводить до помилки компіляції.

    Режим завантаження

    Об'єктні варіанти часто завантажуються ліниво. Задайте importMode у словнику, щоб керувати цим:

    ts
    const dictionary = {
      key: "product",
      importMode: "fetch", // or "dynamic"
      variant: { id: "prod_abc", userId: "user_123" },
      content: { … },
    } satisfies Dictionary;
    
    export default dictionary;

    Див. оптимізацію бандла для деталей про режими static, dynamic і fetch.

    Типові сценарії використання

    • A/B-тести тексту, керовані ключем експерименту
    • Сезонні або рекламні банери
    • Повідомлення під feature-прапорцями
    • Маркетингові кампанії для конкретної локалі
    • Маркетинговий текст за товарами, керований у CMS
    • Контент конкретного користувача або акаунта
    • Будь-який контент, адресований непрозорим ID під час виконання