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, згенерований на сервері, до його запуску відображається базовою мовою.

// 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',
});