Types

InlineTranslationOptions

Справочник API по типу InlineTranslationOptions

Обзор

Тип InlineTranslationOptions используется для передачи переменных во встроенные переводы и задания их поведения при рендеринге. Вы также можете добавить к переводу контекст и идентификатор. Он используется с useGT и msg для передачи переменных во встроенные строковые переводы.

Перевод на этапе сборки: Переводы useGT и msg выполняются на этапе сборки; при этом переменные никогда не переводятся. Вместо этого они вставляются в перевод с нужным форматированием. Обязательно следуйте руководству по деплою.

Справочник

Параметры

Prop

Type

Описание

PropОписание
variablesОбъект, в котором ключи указывают, куда подставляется каждое значение в строке.
$contextПри необходимости добавьте $context как переменную в объект variables, чтобы передать контекст для содержимого (используется при переводе).
$idПри необходимости добавьте $id как переменную в объект variables, чтобы указать идентификатор для использования в редакторе перевода.

Примеры

Контекст

Чтобы добавить контекст к строке, используйте проп $context.

Component.tsx
import { useGT } from 'gt-react';

const Component = () => {
  const t = useGT();
  return <div>{t('Здравствуйте, мир!', { $context: 'официальное приветствие' })}</div>;
};

Передача переменных

Чтобы добавить переменную в строку, используйте синтаксис {variable-name}, где имя переменной заключено в фигурные скобки.

Component.tsx
import { useGT } from 'gt-react';

const Component = () => {
  const t = useGT();
  return <div>{t('Привет, {username}! Как твой день?', { username: 'Brian123' })}</div>;
};

Использование формата сообщений ICU

gt-react поддерживает формат сообщений ICU, который также позволяет форматировать переменные.

Component.tsx
import { useGT } from 'gt-react';

const Component = () => {
  const t = useGT();
  return <div>
    { t(
      'На вашем счёте: {dollars, number, ::currency/USD}!',
      {
        "dollars" : 1000000,
      }
    ) }
  </div>;
};

См. документацию по формату сообщений ICU, чтобы узнать больше о формате сообщений ICU.


Заметки

  • InlineTranslationOptions используется для перевода встроенных строк.
  • Объект variables подставляет значения в текст.
  • Объект variablesOptions задаёт поведение переменных.

Следующие шаги

  • См. useGT для получения дополнительных сведений о переводах встроенных строк.
  • См. формат сообщений ICU для получения дополнительных сведений о вариантах форматирования.

Насколько полезно это руководство?

InlineTranslationOptions