Назад

gt-tanstack-start@0.1.0

Ernest McCarter avatarErnest McCarter
gt-tanstack-startv0.1.0tanstack-starttanstacki18ntranslationvite

Обзор

gt-tanstack-start — первая попытка добавить поддержку i18n, адаптированную для TanStack Start.

Эта библиотека экспериментальная. Она всё ещё находится на раннем этапе развития, и мы будем очень рады обратной связи. Если вам нужны переводы в production-среде с TanStack, пока рекомендуем использовать gt-react.

Что входит

  • initializeGT() — Настраивает менеджер i18n для TanStack Start. Вызовите эту функцию один раз в начале файла корневого маршрута.
  • GTProvider — Оборачивает ваше приложение в контекст перевода, со встроенным определением SSR и локали для TanStack Start.
  • getTranslations() — Асинхронная функция, которую нужно вызывать в корневом загрузчике, чтобы передать переводы в провайдер.
  • getLocale() — Возвращает локаль, определённую для текущего запроса.
  • <T>, <Var>, <LocaleSelector> — Реэкспортируются из gt-react, чтобы вы могли импортировать всё из одного пакета.

Быстрый старт

Установка

npm install gt-tanstack-start

Настройте gt.config.json

{
  "defaultLocale": "en",
  "locales": ["fr", "zh"],
  "files": {
    "gt": {
      "output": "src/_gt/[locale].json"
    }
  }
}

Задайте переменные среды

VITE_GT_PROJECT_ID=your-project-id
VITE_GT_DEV_API_KEY=your-dev-api-key

Создайте загрузчик переводов

// loadTranslations.ts
export async function loadTranslations(locale: string) {
  const translations = await import(`./src/_gt/${locale}.json`);
  return translations.default;
}

Настройка корневого маршрута

// __root.tsx
import { HeadContent, Scripts, createRootRoute } from '@tanstack/react-router';
import {
  initializeGT,
  GTProvider,
  getTranslations,
  getLocale,
} from 'gt-tanstack-start';
import gtConfig from '../../gt.config.json';
import { loadTranslations } from '../../loadTranslations';

initializeGT({
  ...gtConfig,
  projectId: import.meta.env.VITE_GT_PROJECT_ID,
  devApiKey: import.meta.env.VITE_GT_DEV_API_KEY,
  loadTranslations,
});

export const Route = createRootRoute({
  loader: async () => ({
    translations: await getTranslations(),
    locale: getLocale(),
  }),
  shellComponent: RootDocument,
});

function RootDocument({ children }: { children: React.ReactNode }) {
  const { translations, locale } = Route.useLoaderData();
  return (
    <html lang={locale}>
      <head>
        <HeadContent />
      </head>
      <body>
        <GTProvider translations={translations}>
          {children}
        </GTProvider>
        <Scripts />
      </body>
    </html>
  );
}

Перевод контента

import { T } from 'gt-tanstack-start';

export default function Page() {
  return (
    <T>
      <p>This gets translated automatically.</p>
    </T>
  );
}

Что дальше

Это v0.1.0 — основа уже есть, но впереди ещё много работы. Среди ближайших возможностей, которые мы планируем добавить в следующих релизах, — SSG и маршрутизация по локалям.

Если хотите попробовать, будем рады вашим отзывам. Загляните в наш Discord или откройте issue на GitHub.