React `langsys-js-react`

GitHub ↗ StackBlitz で開く ↗

langsys-js-typescript の上に構築された、フックベースの薄いReactバインディングです。コード内のフレーズがそのままルックアップキーであり、基準言語のデフォルトテキストにもなるため、キーファイルも抽出作業も不要です。

AI コーディングエージェントを使っていますか?次のプロンプトを渡してください

Add Langsys translation to this React app.

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

プロジェクトやキーをまだお持ちでない場合は、クイックスタートで 2 分ほどで両方とも用意できます。

初期化する

import { LangsysApp, createLocaleStore } from 'langsys-js-react';

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

シグナルの読み取り

ロケールストアや、React の外部で共有するストアなど、ベース SDK のシグナルをリアクティブに読み取る必要がありますか?useSignal(store) を使うと、変更を購読してコンポーネントを再レンダリングします。(Svelte では同等のものは不要です。シグナルがストアのコントラクトをネイティブに満たしています。)

import { useSignal, useCurrentLocale } from 'langsys-js-react';

// React re-renders only on React state — it can't watch a base-SDK
// signal by itself. useSignal(signal) subscribes and re-renders on change.
function LocaleBadge() {
  const selected = useSignal(locale);   // your createLocaleStore(...)
  const loaded = useCurrentLocale();    // shortcut for the loaded locale

  return <footer>selected {selected} · loaded {loaded}</footer>;
}

インタラクティブプレイグラウンド

フレーズとカテゴリを編集し、パラメーターをフィールドまたは生のJSONで設定してから、ロケールを切り替えて、実際のSDKがリアルタイムで翻訳する様子を確認しましょう。

例 count を 1 にして、また戻してみてください。文法もそれに合わせて変わります。このフレーズはフラットな形で書かれています。Langsys が翻訳時に各ロケール(基準ロケールを含む)の複数形を生成し、SDK が count に応じてブランチを選択します。ICU を手で書く必要はありません。

フレーズ(キー+デフォルト) カテゴリ（任意）

パラメーター

Output

Hello, Sarah! You have 3 new messages.

const t = useT();
t("Hello, {name}! You have {count} new messages.", "Greetings", {"name":"Sarah","count":3})

t() — コンポーネント内のインライン文字列ソースを表示 ↗

import { useT } from 'langsys-js-react';

function Greeting({ name }) {
  const t = useT();
  return <p>{t('Hello, {name}!', 'Greetings', { name })}</p>;
}

どれを使えばよいですか?

翻訳中…	使用	理由
コード内のプレーンな文字列(ラベル、タイトル、メッセージなど)です。パラメーターも含められます。数は単純な形で記述すれば、Langsys が複数形を生成します。	`useT()`	文字列を返します。コード内のフレーズが、そのまま検索キーであり、基準言語のデフォルトテキストにもなります。
インラインのマークアップや動的な値を含む1つの文を、分割せずそのまま扱います。	`<Phrase>`	インライン要素は中立的なトークンに置き換えられるため、翻訳者はマークアップの位置も含めて文全体を並べ替えることができ、実際の要素はレンダリング時に復元されます。
ヒーロー、フッター、カードなど、複数のフレーズを含むマークアップの領域。	`<Translate>`	1 つのタグでその領域を 1 つのコンテンツブロックとして登録します。各テキストはそれぞれ個別のフレーズとして抽出され、マークアップ構造は保持されます。
絶対に翻訳してはいけないもの — ブランド名、コード、ID。	`<DontTranslate>`	トークナイザーとレンダラーはそのサブツリーをスキップします。周囲の文は翻訳されますが、その部分は原文のまま残ります。

目安：文字列 → useT() · マークアップを含む文 → <Phrase> · マークアップを含む領域 → <Translate> · 翻訳しないもの → <DontTranslate>。

左側に各コンテンツコンポーネントを実際にレンダリングし、右側にそれを生成するコードを表示します。

視聴するこれらのプリミティブのデモカットは、今のところSvelteのページにあります。インターフェースは同一で、構文だけが異なります： <Translate> (1:04) · <Phrase> (1:06) · <DontTranslate> (0:34).

`<Translate>` — content block

Welcome to our store

Browse the catalog in your language.

<Translate> — コンテンツブロックソースを表示 ↗

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

<Translate category="Home">
  <h3>Welcome to our store</h3>
  <p>Browse the catalog in your language.</p>
</Translate>

`<Phrase>` — params & markup

Hi %name%, you have %count% items in your cart.

<Phrase> — params とマークアップソースを表示 ↗

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

<Phrase category="Cart" params={{ name: 'Sarah', count: 3 }}>
  Hi %name%, you have %count% items in your cart.
</Phrase>

`<DontTranslate>` — never translated

Welcome! This sentence always stays in English. Thanks for visiting!

<DontTranslate> ソースを表示 ↗

import { DontTranslate, Translate } from 'langsys-js-react';

// Inside a translated region, the marked span alone stays verbatim.
<Translate category="Tour">
  <p>Welcome! <DontTranslate>This sentence always stays in English.</DontTranslate> Thanks for visiting!</p>
</Translate>

性の一致

スペイン語、フランス語、ロシア語では、対象となる人物に合わせて {username} has been invited が語形変化します。Langsys は、複数形と同じように、翻訳時にこれらの分岐を生成します。引数の名前は変数名に _gender を付けたもので、値は male、female、other のいずれかです。分かる場合は必ず渡してください。仕組みと、対応が必要なフレーズの見つけ方 →

gender 引数を渡す

import { useT } from 'langsys-js-react';

function LikeNotice({ user }) {
  const t = useT();
  // Pass the agreement argument alongside the value it inflects.
  return <p>{t('{username} has been invited', 'Team', {
    username: user.name,
    username_gender: user.gender, // 'male' | 'female' | 'other'
  })}</p>;
}

性別が分からない場合は、'other' を明示的に渡してください。これは中立のブランチです。それでも渡されていない場合は、SDK が代わりに other ブランチを使用するため(langsys-js-typescript 0.6.4 以降)、文は正しく表示されます。現在、TypeScript ではインラインの params オブジェクト内の username_gender が拒否されます(エラー TS2353。修正はレビュー中です)。修正が公開されるまでは、先に params オブジェクトを作成し、その変数を渡してください。

サーバーサイドレンダリング

サーバー側でカタログを取得してクライアントに渡すと、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',
});

React langsys-js-react