TypeScript langsys-js-typescript

Базовый SDK, не привязанный к фреймворку, — чистый TypeScript или JavaScript, фреймворк не нужен. Привязки для React, Vue и Svelte — тонкие обёртки над этим пакетом; здесь же он напрямую управляет DOM. Везде действует одно правило: фраза в вашем коде служит и ключом поиска, и значением по умолчанию на базовом языке.

Add Langsys translation to this TypeScript app.

1. Read https://docs.langsys.dev/llms.txt, then follow
   https://docs.langsys.dev/learn/sdk/typescript/ 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-typescript

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

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

import { LangsysApp, createSignal } from 'langsys-js-typescript';

const locale = createSignal('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,
});

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

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

import { t, tSignal } from 'langsys-js-typescript';

const greeting = document.querySelector('#greeting');
const name = 'Sarah';

// tSignal re-emits a fresh t() whenever the locale or catalog
// changes — subscribe once and the element stays translated.
tSignal.subscribe(() => {
  greeting.textContent = t('Hello, {name}!', 'Greetings', { name });
});

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

Практическое правило: строка → t() · предложение с разметкой → Phrase · область разметки → Translate · не трогать → translate="no".

Каждый обработчик ванильного DOM работает вживую слева; код, который его подключает, — справа.

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

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

// <section id="hero">
//   <h3>Welcome to our store</h3>
//   <p>Browse the catalog in your language.</p>
// </section>
new Translate(document.querySelector('#hero'), { category: 'Home' });

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

// <p id="cart-note">Hi {name}, you have {count} items in your cart.</p>
new Phrase(document.querySelector('#cart-note'), {
  category: 'Cart',
  params: { name: 'Sarah', count: 3 },
});

// The standard translate="no" attribute — the tokenizer
// and renderer skip the subtree, so it stays verbatim while
// the sentence around it translates.
// <p id="signin">Welcome! <span translate="no">This sentence always stays in English.</span> Thanks for visiting!</p>
new Translate(document.querySelector('#signin'), { category: 'Tour' });

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

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

import { t } from 'langsys-js-typescript';

// Pass the agreement argument alongside the value it inflects.
t('{username} has been invited', 'Team', {
  username: user.name,
  username_gender: user.gender, // 'male' | 'female' | 'other'
});

Не знаете пол? Явно передайте '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',
});