TypeScript langsys-js-typescript

Bazowe SDK niezależne od frameworka — czysty TypeScript lub JavaScript, bez konieczności użycia frameworka. Powiązania dla React, Vue i Svelte to cienkie nakładki na ten pakiet; tutaj steruje on bezpośrednio DOM. Wszędzie ta sama zasada: fraza w Twoim kodzie jest jednocześnie kluczem wyszukiwania i domyślnym tekstem w języku bazowym.

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.

Instalacja

npm install langsys-js-typescript

Nie masz jeszcze projektu ani kluczy? Szybki start zapewni Ci jedno i drugie w dwie minuty.

Zainicjuj

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

Interaktywne środowisko testowe

Edytuj frazę i kategorię, ustaw parametry jako pola lub surowy JSON, a następnie zmień ustawienia regionalne i zobacz, jak prawdziwe SDK tłumaczy na żywo.

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 });
});

Którego mam użyć?

Zasada praktyczna: ciąg znaków → t() · zdanie ze znacznikami → Phrase · obszar ze znacznikami → Translate · nietykalne → translate="no".

Każda obsługa zdarzeń w czystym DOM działa na żywo po lewej stronie; kod, który ją podłącza, znajduje się po prawej.

Obejrzyj Wersje demonstracyjne tych elementów podstawowych są na razie na stronie Svelte — interfejs jest identyczny, różni się tylko składnia: <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' });

Zgodność rodzaju gramatycznego

W hiszpańskim, francuskim czy rosyjskim {username} has been invited odmienia się w zależności od osoby, której dotyczy. Langsys generuje te warianty podczas tłumaczenia — tak samo jak liczbę mnogą — a argument ma nazwę zmiennej z dopiskiem _gender: male, female lub other. Przekaż go zawsze, gdy go znasz. Jak to działa i jak znaleźć frazy, które tego potrzebują →

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

Nie znasz płci? Przekaż jawnie 'other' — to gałąź neutralna. Jeśli jej mimo to zabraknie, SDK samo wybierze dla Ciebie gałąź other (langsys-js-typescript w wersji 0.6.4 i nowszych), dzięki czemu zdanie nadal będzie brzmiało poprawnie. TypeScript obecnie odrzuca username_gender w literalnym obiekcie parametrów (błąd TS2353; poprawka jest w trakcie przeglądu). Do czasu jej wydania najpierw zbuduj obiekt parametrów, a potem przekaż zmienną.

Renderowanie po stronie serwera

Pobierz katalog na serwerze i przekaż go klientowi, aby SDK uruchamiało się bez ponownego pobierania. SDK tłumaczy w przeglądarce, więc HTML renderowany na serwerze jest w języku bazowym, dopóki SDK się nie uruchomi.

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