Vue langsys-js-vue

Тонкая привязка для Vue 3 поверх langsys-js-typescript, построенная на композables, которые передают базовые сигналы в 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',
});