TypeScript langsys-js-typescript

O SDK base agnóstico de framework — TypeScript ou JavaScript puro, sem exigir nenhum framework. Os bindings para React, Vue e Svelte são wrappers finos sobre este pacote; aqui ele controla o DOM diretamente. A mesma regra em todo lugar: a frase no seu código é, ao mesmo tempo, a chave de busca e o padrão no idioma 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.

Instalar

npm install langsys-js-typescript

Ainda não tem projeto ou chaves? O Início rápido entrega os dois em dois minutos.

Inicializar

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

Playground interativo

Edite a frase e a categoria, defina os parâmetros como campos ou JSON bruto, depois troque o idioma e veja o SDK real traduzir ao vivo.

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

Qual devo usar?

Regra prática: string → t() · frase com marcação → Phrase · trecho de marcação → Translate · intocável → translate="no".

Cada handler de DOM vanilla em execução ao vivo à esquerda; o código que o conecta à direita.

Assistir Por enquanto, os cortes da demonstração destes primitivos estão na página do Svelte — a interface é idêntica, só a sintaxe muda: <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' });

Concordância de gênero

Espanhol, francês ou russo flexionam {username} has been invited de acordo com a pessoa a quem se refere. O Langsys gera essas variantes durante a tradução — do mesmo jeito que gera os plurais — e o argumento recebe o nome da variável, com _gender no final: male, female ou other. Informe-o sempre que souber. Como funciona e como encontrar as frases que precisam dele →

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

Não sabe o gênero? Passe 'other' explicitamente — é a ramificação neutra. Se ele estiver ausente mesmo assim, o SDK usa a ramificação other para você (langsys-js-typescript 0.6.4 e posteriores), então a frase continua sendo lida corretamente. Atualmente o TypeScript rejeita username_gender em um objeto de parâmetros inline (erro TS2353; uma correção está em revisão). Até que ela seja lançada, crie primeiro o objeto de parâmetros e passe a variável.

Renderização no servidor

Busque o catálogo no servidor e entregue-o ao cliente, para que o SDK inicie sem precisar buscá-lo novamente. O SDK traduz no navegador, então o HTML renderizado no servidor fica no idioma base até o SDK iniciar.

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