Отримуйте сповіщення про майбутні випуски Intlayer
    Дата створення:2025-09-09Останнє оновлення:2025-12-30

    Перекладіть ваш вебсайт Tanstack Start за допомогою Intlayer | Інтернаціоналізація (i18n)

    Зміст

    Цей посібник демонструє, як інтегрувати Intlayer для плавної інтернаціоналізації в проєктах Tanstack Start з маршрутизацією, що враховує локаль, підтримкою TypeScript та сучасними практиками розробки.

    Що таке Intlayer?

    Intlayer — інноваційна open-source бібліотека для інтернаціоналізації (i18n), призначена для спрощення підтримки кількох мов у сучасних вебзастосунках.

    За допомогою Intlayer ви можете:

    • Легко керувати перекладами за допомогою декларативних словників на рівні компонентів.
    • Динамічно локалізувати метадані, маршрути та контент.
    • Забезпечити підтримку TypeScript за допомогою автогенерованих типів, що покращує автозаповнення та виявлення помилок.
    • Скористатися розширеними можливостями, такими як динамічне визначення локалі та її перемикання.
    • Увімкніть маршрутизацію з урахуванням локалі за допомогою файлової системи маршрутизації Tanstack Start.

    Покроковий посібник з налаштування Intlayer у застосунку Tanstack Start

    Перегляньте Шаблон додатка на GitHub.

    Крок 1: Створіть проект

    Почніть зі створення нового проєкту TanStack Start, дотримуючись інструкції Створення нового проєкту на сайті TanStack Start.

    Крок 2: Встановіть пакети Intlayer

    Встановіть необхідні пакети, використовуючи обраний менеджер пакетів:

    bash
    npm install intlayer react-intlayernpm install vite-intlayer --save-devnpx intlayer init
    • intlayer

    Основний пакет, який надає інструменти інтернаціоналізації для керування конфігурацією, перекладу, оголошення контенту, транспіляції та команд CLI.

    • react-intlayer Пакет, який інтегрує Intlayer із React-застосунком. Надає провайдери контексту та хуки для інтернаціоналізації в React.

    • vite-intlayer Містить плагін Vite для інтеграції Intlayer з бандлером Vite, а також middleware для визначення пріоритетної локалі користувача, керування cookie та обробки перенаправлень URL.

    Крок 3: Конфігурація вашого проєкту

    Створіть файл конфігурації, щоб налаштувати мови вашого додатка:

    intlayer.config.ts
    import type { IntlayerConfig } from "intlayer";import { Locales } from "intlayer";const config: IntlayerConfig = {  internationalization: {    defaultLocale: Locales.ENGLISH,    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],  },};export default config;
    За допомогою цього файлу конфігурації ви можете налаштувати локалізовані URL-адреси, перенаправлення через middleware, імена cookie, розташування та розширення декларацій контенту, вимкнути логування Intlayer у консолі та інше. Для повного переліку доступних параметрів див. документацію з конфігурації.

    Крок 4: Інтегруйте Intlayer у вашу конфігурацію Vite

    Додайте плагін intlayer до вашої конфігурації:

    vite.config.ts
    import { tanstackStart } from "@tanstack/react-start/plugin/vite";import viteReact from "@vitejs/plugin-react";import { nitro } from "nitro/vite";import { defineConfig } from "vite";import { intlayer } from "vite-intlayer";import viteTsConfigPaths from "vite-tsconfig-paths";const config = defineConfig({  plugins: [    nitro(),    viteTsConfigPaths({      projects: ["./tsconfig.json"],    }),    tanstackStart(),    viteReact(),    intlayer(), // Додати плагін  ],});export default config;
    Плагін Vite intlayer() використовується для інтеграції Intlayer з Vite. Він забезпечує побудову файлів декларацій контенту та відстежує їх у режимі розробки. Він визначає змінні середовища Intlayer у Vite-застосунку. Додатково він надає аліаси для оптимізації продуктивності.

    Крок 5: Створіть компоненти Layout

    Налаштуйте кореневий layout та layout-и для конкретних локалей:

    Кореневий Layout

    src/routes/{-$locale}/route.tsx
    import { createFileRoute, Outlet } from "@tanstack/react-router";import { IntlayerProvider, useLocale } from "react-intlayer";import { useI18nHTMLAttributes } from "@/hooks/useI18nHTMLAttributes";export const Route = createFileRoute("/{-$locale}")({  component: LayoutComponent,});function LayoutComponent() {  const { defaultLocale } = useLocale();  const { locale } = Route.useParams();  return (    <IntlayerProvider locale={locale ?? defaultLocale}>      <Outlet />    </IntlayerProvider>  );}
    Тут {-$locale} — динамічний параметр маршруту, який підставляється поточним локалем. Ця нотація робить слот необов'язковим, що дозволяє використовувати його з режимами маршрутизації, такими як 'prefix-no-default' тощо.

    Зауважте, що цей слот може викликати проблеми, якщо ви використовуєте кілька динамічних сегментів в одному маршруті (наприклад, /{-$locale}/other-path/$anotherDynamicPath/...). У режимі 'prefix-all' можливо краще змінити слот на $locale. У режимах 'no-prefix' або 'search-params' ви можете повністю видалити слот.

    Крок 6: Оголосіть ваш контент

    Створюйте й керуйте деклараціями контенту для зберігання перекладів:

    src/contents/page.content.ts
    import type { Dictionary } from "intlayer";import { t } from "intlayer";const appContent = {  content: {    links: {      about: t({        uk: "Про",        en: "About",        es: "Acerca de",        fr: "À propos",      }),      home: t({        uk: "Головна",        en: "Home",        es: "Inicio",        fr: "Accueil",      }),    },    meta: {      title: t({        uk: "Ласкаво просимо до Intlayer + TanStack Router",        en: "Welcome to Intlayer + TanStack Router",        es: "Bienvenido a Intlayer + TanStack Router",        fr: "Bienvenue à Intlayer + TanStack Router",      }),      description: t({        uk: "Це приклад використання Intlayer з TanStack Router",        en: "This is an example of using Intlayer with TanStack Router",        es: "Este es un ejemplo de uso de Intlayer con TanStack Router",        fr: "Ceci est un exemple d'utilisation d'Intlayer avec TanStack Router",      }),    },  },  key: "app",} satisfies Dictionary;export default appContent;
    Оголошення вмісту можна визначати будь-де у вашому застосунку, за умови, що вони включені у директорію contentDir (за замовчуванням — ./app) та відповідають розширенню файлу декларації вмісту (за замовчуванням — .content.{json,ts,tsx,js,jsx,mjs,mjx,cjs,cjx}).
    Для детальнішої інформації зверніться до документації з оголошення вмісту.

    Крок 7: Створіть компоненти та хуки, що враховують локаль

    Створіть компонент LocalizedLink для навігації з урахуванням локалі:

    src/components/localized-link.tsx
    import type { FC } from "react";import { Link, type LinkComponentProps } from "@tanstack/react-router";import { useLocale } from "react-intlayer";import { getPrefix } from "intlayer";export const LOCALE_ROUTE = "{-$locale}" as const;// Основна утилітаexport type RemoveLocaleParam<T> = T extends string  ? RemoveLocaleFromString<T>  : T;export type To = RemoveLocaleParam<LinkComponentProps["to"]>;type CollapseDoubleSlashes<S extends string> =  S extends `${infer H}//${infer T}` ? CollapseDoubleSlashes<`${H}/${T}`> : S;type LocalizedLinkProps = {  to?: To;} & Omit<LinkComponentProps, "to">;// Допоміжні типиtype RemoveAll<  S extends string,  Sub extends string,> = S extends `${infer H}${Sub}${infer T}` ? RemoveAll<`${H}${T}`, Sub> : S;type RemoveLocaleFromString<S extends string> = CollapseDoubleSlashes<  RemoveAll<S, typeof LOCALE_ROUTE>>;export const LocalizedLink: FC<LocalizedLinkProps> = (props) => {  const { locale } = useLocale();  const { localePrefix } = getPrefix(locale);  return (    <Link      {...props}      params={{        locale: localePrefix,        ...(typeof props?.params === "object" ? props?.params : {}),      }}      to={`/${LOCALE_ROUTE}${props.to}` as LinkComponentProps["to"]}    />  );};

    Цей компонент має дві цілі:

    • Видалити непотрібний префікс {-$locale} з URL.
    • Вставити параметр локалі в URL, щоб користувач був безпосередньо перенаправлений на локалізований маршрут.

    Потім ми можемо створити хук useLocalizedNavigate для програмної навігації:

    src/hooks/useLocalizedNavigate.tsx
    import { useNavigate } from "@tanstack/react-router";import { getPrefix } from "intlayer";import { useLocale } from "react-intlayer";import { LOCALE_ROUTE } from "@/components/localized-link";import type { FileRouteTypes } from "@/routeTree.gen";type StripLocalePrefix<T extends string> = T extends  | `/${typeof LOCALE_ROUTE}`  | `/${typeof LOCALE_ROUTE}/`  ? "/"  : T extends `/${typeof LOCALE_ROUTE}/${infer Rest}`    ? `/${Rest}`    : never;type LocalizedTo = StripLocalePrefix<FileRouteTypes["to"]>;type LocalizedNavigate = {  (to: LocalizedTo): ReturnType<ReturnType<typeof useNavigate>>;  (    opts: { to: LocalizedTo } & Record<string, unknown>  ): ReturnType<ReturnType<typeof useNavigate>>;};export const useLocalizedNavigate = () => {  const navigate = useNavigate();  const { locale } = useLocale();  const localizedNavigate: LocalizedNavigate = (args: any) => {    const { localePrefix } = getPrefix(locale);    if (typeof args === "string") {      return navigate({        to: `/${LOCALE_ROUTE}${args}`,        params: { locale: localePrefix },      });    }    const { to, ...rest } = args;    const localizedTo = `/${LOCALE_ROUTE}${to}` as any;    return navigate({      to: localizedTo,      params: { locale: localePrefix, ...rest } as any,    });  };  return localizedNavigate;};

    Крок 8: Використовуйте Intlayer на ваших сторінках

    Отримуйте доступ до словників контенту по всьому застосунку:

    Локалізована головна сторінка

    src/routes/{-$locale}/index.tsx
    import { createFileRoute } from "@tanstack/react-router";import { getIntlayer } from "intlayer";import { useIntlayer } from "react-intlayer";import LocaleSwitcher from "@/components/locale-switcher";import { LocalizedLink } from "@/components/localized-link";import { useLocalizedNavigate } from "@/hooks/useLocalizedNavigate";export const Route = createFileRoute("/{-$locale}/")({  component: RouteComponent,  head: ({ params }) => {    const { locale } = params;    const metaContent = getIntlayer("app", locale);    return {      meta: [        { title: metaContent.title },        { content: metaContent.meta.description, name: "description" },      ],    };  },});function RouteComponent() {  const content = useIntlayer("app");  const navigate = useLocalizedNavigate();  return (    <div>      <div>        {content.title}        <LocaleSwitcher />        <div>          <LocalizedLink to="/">{content.links.home}</LocalizedLink>          <LocalizedLink to="/about">{content.links.about}</LocalizedLink>        </div>        <div>          <button onClick={() => navigate({ to: "/" })}>            {content.links.home}          </button>          <button onClick={() => navigate({ to: "/about" })}>            {content.links.about}          </button>        </div>      </div>    </div>  );}
    Щоб дізнатися більше про хук useIntlayer, зверніться до документації.

    Крок 9: Створіть компонент перемикача локалі

    Створіть компонент, щоб дозволити користувачам змінювати мову:

    src/components/locale-switcher.tsx
    import { useLocation } from "@tanstack/react-router";import {  getHTMLTextDir,  getLocaleName,  getPathWithoutLocale,  getPrefix,  Locales,} from "intlayer";import type { FC } from "react";import { useLocale } from "react-intlayer";import { LocalizedLink, type To } from "./localized-link";export const LocaleSwitcher: FC = () => {  const { pathname } = useLocation();  const { availableLocales, locale, setLocale } = useLocale();  const pathWithoutLocale = getPathWithoutLocale(pathname);  return (    <ol>      {availableLocales.map((localeEl) => (        <li key={localeEl}>          <LocalizedLink            aria-current={localeEl === locale ? "page" : undefined}            onClick={() => setLocale(localeEl)}            params={{ locale: getPrefix(localeEl).localePrefix }}            to={pathWithoutLocale as To}          >            <span>              {/* Локаль — наприклад FR */}              {localeEl}            </span>            <span>              {/* Назва мови у власній локалі — наприклад Français */}              {getLocaleName(localeEl, locale)}            </span>            <span dir={getHTMLTextDir(localeEl)} lang={localeEl}>              {/* Мова в поточній локалі — наприклад «Francés», коли поточна локаль встановлена як Locales.SPANISH */}              {getLocaleName(localeEl)}            </span>            <span dir="ltr" lang={Locales.ENGLISH}>              {/* Мова англійською — наприклад «French» */}              {getLocaleName(localeEl, Locales.ENGLISH)}            </span>          </LocalizedLink>        </li>      ))}    </ol>  );};
    Щоб дізнатися більше про хук useLocale, зверніться до документації.

    Крок 10: Додати керування атрибутами HTML (необов'язково)

    Створіть хук для керування атрибутами HTML lang і dir:

    src/hooks/useI18nHTMLAttributes.tsx
    // src/hooks/useI18nHTMLAttributes.tsximport { getHTMLTextDir } from "intlayer";import { useEffect } from "react";import { useLocale } from "react-intlayer";export const useI18nHTMLAttributes = () => {  const { locale } = useLocale();  useEffect(() => {    document.documentElement.lang = locale;    document.documentElement.dir = getHTMLTextDir(locale);  }, [locale]);};

    Потім використайте його у кореневому компоненті:

    src/routes/{-$locale}/index.tsx
    import { createFileRoute, Outlet } from "@tanstack/react-router";import { IntlayerProvider } from "react-intlayer";import { useI18nHTMLAttributes } from "@/hooks/useI18nHTMLAttributes"; // імпортуємо хукexport const Route = createFileRoute("/{-$locale}")({  component: LayoutComponent,});function LayoutComponent() {  useI18nHTMLAttributes(); // додайте цей рядок  const { locale } = Route.useParams();  const { defaultLocale } = useLocale();  return (    <IntlayerProvider      locale={locale ?? defaultLocale} // Якщо локаль не вказана як параметр, буде використана локаль за замовчуванням    >      <Outlet />    </IntlayerProvider>  );}

    Крок 11: Додати middleware (необов'язково)

    Ви також можете використовувати intlayerProxy для додавання маршрутизації на стороні сервера у вашому додатку. Цей плагін автоматично визначатиме поточну локаль на основі URL і встановлюватиме відповідний cookie з локаллю. Якщо локаль не вказана, плагін визначить найбільш підходящу локаль на основі мовних налаштувань браузера користувача. Якщо локаль не буде виявлена, відбудеться перенаправлення на локаль за замовчуванням.

    Зверніть увагу, що щоб використовувати intlayerProxy у production, потрібно перемістити пакет vite-intlayer з devDependencies до dependencies.
    vite.config.ts
    import { reactRouter } from "@react-router/dev/vite";import tailwindcss from "@tailwindcss/vite";import { defineConfig } from "vite";import { intlayer, intlayerProxy } from "vite-intlayer";import tsconfigPaths from "vite-tsconfig-paths";export default defineConfig({  plugins: [    intlayerProxy(), // Проксі слід розміщувати перед сервером, якщо ви використовуєте Nitro    tailwindcss(),    reactRouter(),    tsconfigPaths(),    intlayer(),  ],});

    Крок 12: Інтернаціоналізуйте свої метадані (необов'язково)

    Ви також можете використовувати хук getIntlayer, щоб отримувати ваші словники контенту по всьому застосунку:

    src/routes/{-$locale}/index.tsx
    import { createFileRoute } from "@tanstack/react-router";import { getIntlayer } from "intlayer";export const Route = createFileRoute("/{-$locale}/")({  component: RouteComponent,  head: ({ params }) => {    const { locale } = params;    const metaContent = getIntlayer("page-metadata", locale);    return {      meta: [        { title: metaContent.title },        { content: metaContent.description, name: "description" },      ],    };  },});

    Крок 13: Отримання локалі у серверних діях (Необов'язково)

    Можливо, ви захочете отримувати поточну локаль всередині серверних дій або API-ендпоїнтів. Ви можете зробити це за допомогою хелпера getLocale з intlayer.

    Ось приклад із використанням серверних функцій TanStack Start:

    src/routes/{-$locale}/index.tsx
    import { createServerFn } from "@tanstack/react-start";import {  getRequestHeader,  getRequestHeaders,} from "@tanstack/react-start/server";import { getCookie, getIntlayer, getLocale } from "intlayer";export const getLocaleServer = createServerFn().handler(async () => {  const locale = await getLocale({    // Отримати cookie з запиту (за замовчуванням: 'INTLAYER_LOCALE')    getCookie: (name) => {      const cookieString = getRequestHeader("cookie");      return getCookie(name, cookieString);    },    // Отримати заголовок з запиту (за замовчуванням: 'x-intlayer-locale')    // Резервне відпрацювання через узгодження Accept-Language    getHeader: (name) => getRequestHeader(name),  });  // Отримати певний контент за допомогою getIntlayer()  const content = getIntlayer("app", locale);  return { locale, content };});

    Крок 14: Керування сторінками «Не знайдено» (необов'язково)

    Коли користувач переходить на неіснуючу сторінку, ви можете відобразити власну сторінку «не знайдено», і префікс локалі може впливати на те, як ця сторінка викликається.

    Розуміння обробки 404 у TanStack Router з префіксами локалі

    У TanStack Router обробка сторінок 404 для локалізованих маршрутів вимагає багаторівневого підходу:

    1. Виділений маршрут 404: спеціальний маршрут для відображення інтерфейсу сторінки 404
    2. Валідація на рівні маршруту: перевіряє префікси локалі та перенаправляє некоректні на 404
    3. Catch-all route: Перехоплює будь-які невідповідні шляхи в межах сегмента локалі
    src/routes/{-$locale}/404.tsx
    import { createFileRoute } from "@tanstack/react-router";// Це створює спеціальний маршрут /[locale]/404// Використовується як прямий маршрут і імпортується як компонент в інших файлахexport const Route = createFileRoute("/{-$locale}/404")({  component: NotFoundComponent,});// Експортується окремо, щоб його можна було повторно використовувати в notFoundComponent та catch-all маршрутахexport function NotFoundComponent() {  return (    <div>      <h1>404</h1>    </div>  );}
    src/routes/{-$locale}/route.tsx
    import { createFileRoute, Outlet, redirect } from "@tanstack/react-router";import { validatePrefix } from "intlayer";import { IntlayerProvider, useLocale } from "react-intlayer";import { LocaleSwitcher } from "@/components/locale-switcher";import { NotFoundComponent } from "./404";export const Route = createFileRoute("/{-$locale}")({  // beforeLoad виконується перед відображенням маршруту (як на сервері, так і на клієнті)  // Це ідеальне місце для валідації префіксу локалі  beforeLoad: ({ params }) => {    // Отримати локаль з параметрів маршруту (не з заголовків сервера, оскільки beforeLoad виконується і на клієнті, і на сервері)    const localeParam = params.locale;    // validatePrefix перевіряє, чи дійсна локаль згідно з вашою конфігурацією intlayer    // Повертає: { isValid: boolean, localePrefix: string }    // - isValid: true якщо префікс відповідає налаштованій локалі (або порожній, коли префікс опціональний)    // - localePrefix: перевірений префікс або префікс локалі за замовчуванням для перенаправлень    const { isValid, localePrefix } = validatePrefix(localeParam);    if (isValid) {      // Локаль дійсна, дозволяємо маршруту рендеритися як зазвичай      return;    }    // Неприпустимий префікс локалі (наприклад, /xyz/about, де "xyz" не є дійсною локаллю)    // Перенаправити на сторінку 404 з дійсним префіксом локалі    // Це гарантує, що сторінка 404 буде правильно локалізована    throw redirect({      to: "/{-$locale}/404",      params: { locale: localePrefix },    });  },  component: RouteComponent,  // notFoundComponent викликається, коли дочірній маршрут не існує  // наприклад, /en/non-existent-page спричиняє це в межах layout для /en  notFoundComponent: NotFoundLayout,});function RouteComponent() {  const { defaultLocale } = useLocale();  const { locale } = Route.useParams();  return (    // Обгортає весь сегмент локалі компонентом IntlayerProvider    // Використовує defaultLocale, якщо параметр locale не визначений (режим необов'язкового префіксу)    <IntlayerProvider locale={locale ?? defaultLocale}>      <Outlet />    </IntlayerProvider>  );}// NotFoundLayout обгортає компонент 404 компонентом IntlayerProvider// Це гарантує, що переклади працюють і на сторінці 404function NotFoundLayout() {  const { defaultLocale } = useLocale();  const { locale } = Route.useParams();  return (    <IntlayerProvider locale={locale ?? defaultLocale}>      <NotFoundComponent />      {/* Додати LocaleSwitcher, щоб користувачі могли змінювати мову навіть на сторінці 404 */}      <LocaleSwitcher />    </IntlayerProvider>  );}
    src/routes/{-$locale}/$.tsx
    import { createFileRoute } from "@tanstack/react-router";import { NotFoundComponent } from "./404";// Маркер $ (splat/catch-all) маршрут відповідає будь-якому шляху, який не відповідає іншим маршрутам// наприклад, /en/some/deeply/nested/invalid/path// Це гарантує, що ВСІ невідповідні шляхи всередині локалі показуватимуть сторінку 404// Без цього, невідповідні глибокі шляхи можуть показувати порожню сторінку або викликати помилкуexport const Route = createFileRoute("/{-$locale}/$")({  component: NotFoundComponent,});

    Крок 15: Налаштування TypeScript (необов'язково)

    Intlayer використовує module augmentation, щоб отримати переваги TypeScript і зміцнити ваш codebase.

    Переконайтеся, що ваша конфігурація TypeScript включає автогенеровані типи:

    tsconfig.json
    {  // ... ваші наявні конфігурації  include: [    // ... ваші наявні includes    ".intlayer/**/*.ts", // Включає автогенеровані типи  ],}

    Налаштування Git

    Рекомендується ігнорувати файли, згенеровані Intlayer. Це дозволить уникнути їх коміту в ваш Git-репозиторій.

    Для цього ви можете додати наступні інструкції до файлу .gitignore:

    .gitignore
    # Ігнорувати файли, згенеровані Intlayer.intlayer

    Розширення VS Code

    Щоб покращити досвід розробки з Intlayer, ви можете встановити офіційне Intlayer VS Code Extension.

    Встановити з VS Code Marketplace

    Це розширення надає:

    • Автозаповнення для ключів перекладу.
    • Виявлення помилок у реальному часі для відсутніх перекладів.
    • Вбудовані попередні перегляди перекладеного вмісту.
    • Швидкі дії для простого створення та оновлення перекладів.

    Для детальнішої інформації про використання розширення зверніться до документації Intlayer VS Code Extension.


    Рухатися далі

    Щоб піти далі, ви можете реалізувати візуальний редактор або винести свій вміст у зовнішню систему, використовуючи CMS.


    Посилання на документацію

    Цей вичерпний посібник містить усе необхідне для інтеграції Intlayer з Tanstack Start для повністю інтернаціоналізованого додатка з маршрутизацією, що враховує локаль, та підтримкою TypeScript.

    Отримуйте сповіщення про майбутні випуски Intlayer