InlineTranslationOptions
Справочник API по типу InlineTranslationOptions
Обзор
Тип InlineTranslationOptions используется для передачи переменных во встроенные переводы и задания их поведения при рендеринге.
К переводу также можно добавить контекст и идентификатор.
Он используется с useGT, getGT и msg для передачи переменных во встроенные строковые переводы.
Перевод на этапе сборки:
При использовании useGT, getGT и msg переводятся только исходные строки, переменные не переводятся.
См. tx для перевода строк с динамическим содержимым.
Справочные материалы
Параметры
Prop
Type
Описание
| Prop | Описание |
|---|---|
variables | Объект, в котором ключи указывают, куда в строке маппится каждое значение. |
$context | При необходимости добавьте $context как переменную в объект variables, чтобы предоставить контекст для содержимого (используется при переводе). |
$id | При необходимости добавьте $id как переменную в объект variables, чтобы указать идентификатор для использования в редакторе переводов. |
Примеры
Контекст
Чтобы добавить контекст к строке, используем проп $context.
import { useGT } from 'gt-next';
const Component = () => {
const t = useGT();
return <div>{t('Здравствуйте, мир!', { $context: 'формальное приветствие' })}</div>;
};Передача переменных
Чтобы добавить переменную в строку, используйте синтаксис {variable-name}, где имя переменной заключено в фигурные скобки.
import { useGT } from 'gt-next';
const Component = () => {
const t = useGT();
return <div>{t('Привет, {username}! Как проходит твой день?', { username: 'Brian123' })}</div>;
};Использование формата сообщений ICU
gt-next поддерживает формат сообщений ICU, позволяющий форматировать и переменные.
import { useGT } from 'gt-next';
const Component = () => {
const t = useGT();
return <div>
{ t(
'Баланс вашего счёта: {dollars, number, ::currency/USD}!',
{
"dollars" : 1000000,
}
) }
</div>;
};См. документацию по формату сообщений ICU для получения дополнительной информации о формате сообщений ICU.
Примечания
InlineTranslationOptionsиспользуется для перевода строк «на месте».- Объект
variablesподставляет значения в текст. - Объект
variablesOptionsзадаёт поведение переменных.
Дальнейшие шаги
- Подробнее см. в
useGTиgetGTо встроенных переводах строк. - Подробнее о вариантах форматирования см. в разделе
ICU message format.
Насколько полезно это руководство?