Vue langsys-js-vue

Тонка прив'язка для Vue 3 поверх langsys-js-typescript, побудована на композаблах, які передають базові сигнали в shallowRef. Фраза у вашому коді одночасно є ключем пошуку та значенням за замовчуванням для базової мови.

Add Langsys translation to this Vue app.

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

Ще немає проєкту чи ключів? Швидкий старт дасть вам і те, і інше за дві хвилини.

Ініціалізувати

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

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

Читання сигналів

Потрібно реактивно читати сховище локалей або будь-який сигнал базового SDK, як-от сховище, яким ви ділитеся поза Vue? useSignal(store) передає його в shallowRef, який Vue може відстежувати. (Для Svelte аналога не потрібно: сигнали нативно відповідають його контракту сховища.)

<script setup>
import { useSignal, useCurrentLocale } from 'langsys-js-vue';

// Vue tracks only its own refs — a base-SDK signal is invisible to it.
// useSignal(signal) bridges it into a shallowRef Vue can track.
const selected = useSignal(locale);   // your createLocaleStore(...)
const loaded = useCurrentLocale();    // shortcut for the loaded locale
</script>

<template>
  <footer>selected {{ selected }} · loaded {{ loaded }}</footer>
</template>

Інтерактивний пісочник

Відредагуйте фразу й категорію, задайте параметри як поля або сирий JSON, потім змініть локаль і спостерігайте, як справжній SDK перекладає наживо.

const t = useT();

<p>{{ t("Hello, {name}! You have {count} new messages.", "Greetings", {"name":"Sarah","count":3}) }}</p>

<script setup>
import { useT } from 'langsys-js-vue';
const t = useT();
const name = 'Sarah';
</script>

<template>
  <p>{{ t('Hello, {name}!', 'Greetings', { name }) }}</p>
</template>

Який із них мені використовувати?

Практичне правило: рядок → useT() · речення з розміткою → <Phrase> · ділянка розмітки → <Translate> · не чіпати → <DontTranslate>.

Кожен компонент вмісту відображається наживо ліворуч, а код, що його створює, — праворуч.

Дивитися Демонстрації цих примітивів поки що розміщено на сторінці Svelte — інтерфейс однаковий, відрізняється лише синтаксис: <Translate> (1:04) · <Phrase> (1:06) · <DontTranslate> (0:34).

<script setup>
import { Translate } from 'langsys-js-vue';
</script>

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

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

<!-- 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. Передавайте його щоразу, коли знаєте значення. Як це працює і як знайти фрази, яким це потрібно →

<script setup>
import { useT } from 'langsys-js-vue';
const props = defineProps({ user: Object });
const t = useT();
</script>

<template>
  <!-- Pass the agreement argument alongside the value it inflects.
       user.gender is 'male' | 'female' | 'other'. -->
  <p>{{ t('{username} has been invited', 'Team',
       { username: props.user.name, username_gender: props.user.gender }) }}</p>
</template>

Не знаєте рід? Явно передайте 'other' — це нейтральна гілка. Якщо значення все одно відсутнє, SDK сама вибере гілку other (langsys-js-typescript версії 0.6.4 і новіших), тож речення залишиться коректним. Наразі TypeScript відхиляє username_gender у вбудованому об’єкті параметрів (помилка TS2353; виправлення на розгляді). Поки його не випущено, спочатку створіть об’єкт параметрів, а потім передайте змінну.

Серверний рендеринг

Отримайте каталог на сервері (Nuxt) і передайте його клієнту, щоб SDK запускався без повторного завантаження. SDK перекладає в браузері, тож серверний HTML залишається базовою мовою, доки SDK не запуститься.

// Nuxt: the server plugin seeds the catalog, the client init reuses it.
LangsysApp.init({
  projectid, key,
  UserLocaleStore: locale,
  initialTranslations,        // fetched on the server
  initialTranslationsLocale,  // fetched on the server
  ssrTokenStrategy: 'client',
});