React langsys-js-react

Тонкая React-обёртка над langsys-js-typescript, построенная на хуках. Фраза в вашем коде одновременно служит ключом поиска и значением по умолчанию на базовом языке: ни файла ключей, ни шага извлечения.

Add Langsys translation to this React app.

1. Read https://docs.langsys.dev/llms.txt, then follow
   https://docs.langsys.dev/learn/sdk/react/ for the install and setup.
2. The English text in the code is the translation key. Wrap user-facing
   strings as they are: no keys file, no extraction step, and no
   hand-written plural or gender branches (Langsys generates those).
3. Read the Langsys project id and API key from environment variables.
   The write key is for development and servers only; anything shipped
   to the browser gets the read-only key.
4. Keep brand names and user-generated content out of translation.

Установка

npm install langsys-js-react

Ещё нет проекта или ключей? Быстрый старт даст вам и то и другое за две минуты.

Инициализировать

import { LangsysApp, createLocaleStore } from 'langsys-js-react';

const locale = createLocaleStore('en-US');

await LangsysApp.init({
  projectid: import.meta.env.VITE_LANGSYS_PROJECT_ID,
  key: import.meta.env.VITE_LANGSYS_API_KEY, // read-only in the browser
  UserLocaleStore: locale,
});

Чтение сигналов

Нужно реактивно читать хранилище локалей или любой другой сигнал базового SDK, например хранилище, которым вы делитесь за пределами React? useSignal(store) подписывается на него и перерисовывает ваш компонент при изменении. (В Svelte аналог не нужен: сигналы там изначально соответствуют контракту хранилищ.)

import { useSignal, useCurrentLocale } from 'langsys-js-react';

// React re-renders only on React state — it can't watch a base-SDK
// signal by itself. useSignal(signal) subscribes and re-renders on change.
function LocaleBadge() {
  const selected = useSignal(locale);   // your createLocaleStore(...)
  const loaded = useCurrentLocale();    // shortcut for the loaded locale

  return <footer>selected {selected} · loaded {loaded}</footer>;
}

Интерактивная песочница

Измените фразу и категорию, задайте параметры в виде полей или сырого JSON, затем переключите локаль и посмотрите, как настоящий SDK переводит в реальном времени.

const t = useT();
t("Hello, {name}! You have {count} new messages.", "Greetings", {"name":"Sarah","count":3})

import { useT } from 'langsys-js-react';

function Greeting({ name }) {
  const t = useT();
  return <p>{t('Hello, {name}!', 'Greetings', { name })}</p>;
}

Что мне использовать?

Практическое правило: строка → useT() · предложение с разметкой → <Phrase> · область разметки → <Translate> · не трогать → <DontTranslate>.

Каждый компонент контента отображается вживую слева, а код, который его создаёт, — справа.

Смотреть Демонстрации этих примитивов пока находятся на странице Svelte — интерфейс идентичен, отличается только синтаксис: <Translate> (1:04) · <Phrase> (1:06) · <DontTranslate> (0:34).

import { Translate } from 'langsys-js-react';

<Translate category="Home">
  <h3>Welcome to our store</h3>
  <p>Browse the catalog in your language.</p>
</Translate>

import { Phrase } from 'langsys-js-react';

<Phrase category="Cart" params={{ name: 'Sarah', count: 3 }}>
  Hi %name%, you have %count% items in your cart.
</Phrase>

import { DontTranslate, Translate } from 'langsys-js-react';

// Inside a translated region, the marked span alone stays verbatim.
<Translate category="Tour">
  <p>Welcome! <DontTranslate>This sentence always stays in English.</DontTranslate> Thanks for visiting!</p>
</Translate>

Согласование по роду

В испанском, французском и русском языках {username} has been invited изменяется в зависимости от того, о ком идёт речь. Langsys генерирует эти варианты при переводе — так же, как и формы множественного числа, — а аргумент называется по имени переменной с добавлением _gender: male, female или other. Передавайте его всегда, когда он вам известен. Как это работает и как найти фразы, которым он нужен →

import { useT } from 'langsys-js-react';

function LikeNotice({ user }) {
  const t = useT();
  // Pass the agreement argument alongside the value it inflects.
  return <p>{t('{username} has been invited', 'Team', {
    username: user.name,
    username_gender: user.gender, // 'male' | 'female' | 'other'
  })}</p>;
}

Не знаете пол? Явно передайте 'other' — это нейтральная ветка. Если значение всё же отсутствует, SDK сама выберет ветку other (langsys-js-typescript версии 0.6.4 и новее), так что предложение всё равно будет читаться корректно. Сейчас TypeScript отклоняет username_gender во встроенном объекте параметров (ошибка TS2353; исправление проходит проверку). Пока оно не выпущено, сначала создайте объект параметров и передайте переменную.

Серверный рендеринг

Загрузите каталог на сервере и передайте его клиенту, чтобы SDK запускался без повторной загрузки. SDK переводит в браузере, поэтому HTML, отрендеренный на сервере, остаётся на базовом языке, пока SDK не запустится.

// The server fetches the catalog; the client init starts from it
// instead of fetching it again, and translates once it runs.
LangsysApp.init({
  projectid, key,
  UserLocaleStore: locale,
  initialTranslations,        // fetched on the server
  initialTranslationsLocale,  // fetched on the server
  ssrTokenStrategy: 'client',
});