TypeScript langsys-js-typescript

Le SDK de base indépendant de tout framework — TypeScript ou JavaScript pur, sans framework requis. Les intégrations React, Vue et Svelte sont de fines surcouches de ce paquet ; ici, il pilote directement le DOM. Même règle partout : la phrase dans votre code est à la fois la clé de recherche et la valeur par défaut dans la langue de base.

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.

Installer

npm install langsys-js-typescript

Pas encore de projet ni de clés ? Le démarrage rapide vous fournit les deux en deux minutes.

Initialiser

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

Bac à sable interactif

Modifiez la phrase et la catégorie, définissez les paramètres sous forme de champs ou en JSON brut, puis changez de langue et regardez le vrai SDK traduire en direct.

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

Lequel dois-je utiliser ?

Règle générale : chaîne → t() · phrase avec balisage → Phrase · zone de balisage → Translate · intouchable → translate="no".

Chaque gestionnaire DOM vanilla s'exécute en direct à gauche ; le code qui le met en place est à droite.

Regarder Les démos de ces primitives se trouvent pour l'instant sur la page Svelte : l'interface est identique, seule la syntaxe diffère : <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' });

Accord en genre

L'espagnol, le français ou le russe accordent {username} has been invited selon la personne concernée. Langsys génère ces variantes pendant la traduction — comme il génère les pluriels — et l'argument porte le nom de la variable, suivi de _gender : male, female ou other. Transmettez-le dès que vous le connaissez. Comment cela fonctionne, et comment repérer les phrases concernées →

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

Vous ne connaissez pas le genre ? Passez explicitement 'other' — c’est la branche neutre. S’il manque malgré tout, le SDK utilise automatiquement la branche other (langsys-js-typescript 0.6.4 et versions ultérieures), si bien que la phrase reste correcte. TypeScript rejette actuellement username_gender dans un objet de paramètres en ligne (erreur TS2353 ; un correctif est en cours de revue). En attendant sa publication, construisez d’abord l’objet de paramètres, puis passez la variable.

Rendu côté serveur

Récupérez le catalogue côté serveur et transmettez-le au client, afin que le SDK démarre sans avoir à le récupérer de nouveau. Le SDK traduit dans le navigateur ; le HTML rendu côté serveur reste donc dans la langue de base jusqu'à son démarrage.

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