Внедрение компонентов

ComponentCustomOptions

Пользовательские свойства компонентов для Vue I18n

Подпись:

typescript

export interface ComponentCustomOptions;

i18n

Опции Vue I18n для компонента

Подпись:

typescript

i18n?: VueI18nOptions;

См. также

VueI18nOptions

ComponentCustomProperties

Пользовательские опции компонентов для Vue I18n

Подпись:

typescript

export interface ComponentCustomProperties;

Подробности

Эти свойства внедряются во все дочерние компоненты

$i18n

Экспортированный глобальный экземпляр Composer или глобальный экземпляр VueI18n.

Подпись:

typescript

$i18n: VueI18n | ExportedGlobalComposer;

Подробности

Вы можете получить экспортированный экземпляр Composer, который экспортируется из глобального Composer экземпляра, созданного с помощью createI18n, или глобального VueI18n экземпляра.

Вы можете получить экспортированный экземпляр Composer в режиме Composition API, или экземпляр Vuei18n в режиме Legacy API, который является экземпляром, к которому можно обратиться с помощью этого свойства.

Локали, сообщения локализации и другие ресурсы, управляемые экземпляром, ссылка на который указана этим свойством, действительны в глобальной области видимости.

Если опция компонента i18n не указана, то это то же самое, что и экземпляр VueI18n, который может быть доступен через глобальный экземпляр i18n global.

См. также

$t(key)

Перевод сообщения локализации

Подпись:

typescript

$t(key: Key): TranslateResult;

Подробности

Если используется в реактивном контексте, то будет пересчитано при изменении локали.

В режиме Composition API, $t внедряется через app.config.globalProperties. Входной/выходной формат аналогичен Composer, работает в глобальной области видимости. Подробнее см. Composer#t.

В режиме Legacy API, входной/выходной формат аналогичен экземпляру VueI18n. Подробнее см. VueI18n#t.

См. также

Параметры

Параметр	Тип	Описание
key	Key	Ключ целевого сообщения локализации

Возвращает

Переведённое сообщение

$t(key, locale)

УВЕДОМЛЕНИЕ

Эта сигнатура API доступна только в режиме Legacy API и поддерживается до v9.

Перевод сообщения локализации

Подпись:

typescript

$t(key: Key, locale: Locale): TranslateResult;

Подробности

Перегрузка $t. Подробнее см. примечания к $t.

Параметры

Параметр	Тип	Описание
key	Key	Ключ целевого сообщения локализации
locale	Locale	Локаль, переопределяющая локаль глобальной или локальной области видимости

Возвращает

Переведённое сообщение

$t(key, locale, list)

УВЕДОМЛЕНИЕ

Эта сигнатура API доступна только в режиме Legacy API и поддерживается до v9.

Перевод сообщения локализации

Подпись:

typescript

$t(key: Key, locale: Locale, list: unknown[]): TranslateResult;

Подробности

Перегрузка $t. Подробнее см. примечания к $t.

Параметры

Параметр	Тип	Описание
key	Key	Ключ целевого сообщения локализации
locale	Locale	Локаль, переопределяющая локаль глобальной или локальной области видимости
list	unknown[]	Значения интерполяции списка

Возвращает

Переведённое сообщение

$t(key, locale, named)

УВЕДОМЛЕНИЕ

Эта сигнатура API доступна только в режиме Legacy API и поддерживается до v9.

Перевод сообщения локализации

Подпись:

typescript

$t(key: Key, locale: Locale, named: object): TranslateResult;

Подробности

Перегрузка $t. Подробнее см. примечания к $t.

Параметры

Параметр	Тип	Описание
key	Key	Ключ целевого сообщения локализации
locale	Locale	Локаль, переопределяющая локаль глобальной или локальной области видимости
named	object	Значения интерполяции по имени

Возвращает

Переведённое сообщение

$t(key, plural)

Перевод сообщения локализации

Подпись:

typescript

$t(key: Key, plural: number): TranslateResult;

ПРИМЕЧАНИЕ

Поддерживается только для режима Composition API до v9. v10 или более поздние версии также могут использоваться в Legacy API режиме.

Подробности

Перегрузка $t. Подробнее см. примечания к $t.

Параметры

Параметр	Тип	Описание
key	Key	Ключ целевого сообщения локализации
plural	number	Номер выбора множественного числа

Возвращает

Переведённое сообщение

$t(key, plural, options)

Перевод сообщения локализации

Подпись:

typescript

$t(key: Key, plural: number, options: TranslateOptions): TranslateResult;

ПРИМЕЧАНИЕ

Подробности

Перегрузка $t. Подробнее см. примечания к $t.

Параметры

Параметр	Тип	Описание
key	Key	Ключ целевого сообщения локализации
plural	number	Номер выбора множественного числа
options	TranslateOptions	Параметры, см. TranslateOptions

Возвращает

Переведённое сообщение

$t(key, defaultMsg)

Перевод сообщения локализации

Подпись:

typescript

$t(key: Key, defaultMsg: string): TranslateResult;

ПРИМЕЧАНИЕ

Подробности

Перегрузка $t. Подробнее см. примечания к $t.

Параметры

Параметр	Тип	Описание
key	Key	Ключ целевого сообщения локализации
defaultMsg	string	Строковое значение по умолчанию для возврата, если перевод не найден

Возвращает

Переведённое сообщение

$t(key, defaultMsg, options)

Перевод сообщения локализации

Подпись:

typescript

$t(key: Key, defaultMsg: string, options: TranslateOptions): TranslateResult;

ПРИМЕЧАНИЕ

Подробности

Перегрузка $t. Подробнее см. примечания к $t.

Параметры

Параметр	Тип	Описание
key	Key	Ключ целевого сообщения локализации
defaultMsg	string	Строковое значение по умолчанию для возврата, если перевод не найден
options	TranslateOptions	Параметры, см. TranslateOptions

Возвращает

Переведённое сообщение

$t(key, list)

Перевод сообщения локализации

Подпись:

typescript

$t(key: Key, list: unknown[]): TranslateResult;

Подробности

Перегрузка $t. Подробнее см. примечания к $t.

Параметры

Параметр	Тип	Описание
key	Key	Ключ целевого сообщения локализации
list	unknown[]	Значения интерполяции списка

Возвращает

Переведённое сообщение

$t(key, list, plural)

Перевод сообщения локализации

Подпись:

typescript

$t(key: Key, list: unknown[], plural: number): TranslateResult;

ПРИМЕЧАНИЕ

Подробности

Перегрузка $t. Подробнее см. примечания к $t.

Параметры

Параметр	Тип	Описание
key	Key	Ключ целевого сообщения локализации
list	unknown[]	Значения интерполяции списка
plural	number	Номер выбора множественного числа

Возвращает

Переведённое сообщение

$t(key, list, defaultMsg)

Перевод сообщения локализации

Подпись:

typescript

$t(key: Key, list: unknown[], defaultMsg: string): TranslateResult;

ПРИМЕЧАНИЕ

Подробности

Перегрузка $t. Подробнее см. примечания к $t.

Параметры

Параметр	Тип	Описание
key	Key	Ключ целевого сообщения локализации
list	unknown[]	Значения интерполяции списка
defaultMsg	string	Строковое значение по умолчанию для возврата, если перевод не найден

Возвращает

Переведённое сообщение

$t(key, list, options)

Перевод сообщения локализации

Подпись:

typescript

$t(key: Key, list: unknown[], options: TranslateOptions): TranslateResult;

ПРИМЕЧАНИЕ

Подробности

Перегрузка $t. Подробнее см. примечания к $t.

Параметры

Параметр	Тип	Описание
key	Key	Ключ целевого сообщения локализации
list	unknown[]	Значения интерполяции списка
options	TranslateOptions	Параметры, см. TranslateOptions

Возвращает

Переведённое сообщение

$t(key, named)

Перевод сообщения локализации

Подпись:

typescript

$t(key: Key, named: NamedValue): TranslateResult;

Подробности

Перегрузка $t. Подробнее см. примечания к $t.

Параметры

Параметр	Тип	Описание
key	Key	Ключ целевого сообщения локализации
named	NamedValue	Значения интерполяции по имени

Возвращает

Переведённое сообщение

$t(key, named, plural)

Перевод сообщения локализации

Подпись:

typescript

$t(key: Key, named: NamedValue, plural: number): TranslateResult;

ПРИМЕЧАНИЕ

Подробности

Перегрузка $t. Подробнее см. примечания к $t.

Параметры

Параметр	Тип	Описание
key	Key	Ключ целевого сообщения локализации
named	NamedValue	Значения интерполяции по имени
plural	number	Номер выбора множественного числа

Возвращает

Переведённое сообщение

$t(key, named, defaultMsg)

Перевод сообщения локализации

Подпись:

typescript

$t(key: Key, named: NamedValue, defaultMsg: string): TranslateResult;

ПРИМЕЧАНИЕ

Подробности

Перегрузка $t. Подробнее см. примечания к $t.

Параметры

Параметр	Тип	Описание
key	Key	Ключ целевого сообщения локализации
named	NamedValue	Значения интерполяции по имени
defaultMsg	string	Строковое значение по умолчанию для возврата, если перевод не найден

Возвращает

Переведённое сообщение

$t(key, named, options)

Перевод сообщения локализации

Подпись:

typescript

$t(key: Key, named: NamedValue, options: TranslateOptions): TranslateResult;

ПРИМЕЧАНИЕ

Подробности

Перегрузка $t. Подробнее см. примечания к $t.

Параметры

Параметр	Тип	Описание
key	Key	Ключ целевого сообщения локализации
named	NamedValue	Значения интерполяции по имени
options	TranslateOptions	Параметры, см. TranslateOptions

Возвращает

Переведённое сообщение

$rt(message)

Разрешить перевод сообщения локализации

Подпись:

typescript

$rt(message: MessageFunction<VueMessageType> | VueMessageType): string;

Подробности

Если используется в реактивном контексте, то будет пересчитано при изменении локали.

В режиме Composition API, $rt внедряется через app.config.globalProperties. Входной/выходной формат аналогичен Composer, работает в глобальной области видимости. Подробнее см. Composer#rt.

В режиме Legacy API, входной/выходной формат аналогичен экземпляру VueI18n. Подробнее см. VueI18n#rt.

См. также

Параметры

Параметр	Тип	Описание
message	MessageFunction<VueMessageType> \| VueMessageType	Целевое сообщение локализации для разрешения. Вам нужно указать сообщение локализации, возвращаемое `$tm`.

Возвращает

Переведённое сообщение

$rt(message, plural, options)

Разрешить перевод сообщения локализации для множественных чисел

Подпись:

typescript

$rt(message: MessageFunction<VueMessageType> | VueMessageType, plural: number, options?: TranslationOptions): string;

Подробности

Перегрузка $rt. Подробнее см. примечания к $rt.

Параметры

Параметр	Тип	Описание
message	MessageFunction<VueMessageType> \| VueMessageType	Целевое сообщение локализации для разрешения. Вам нужно указать сообщение локализации, возвращаемое `$tm`.
plural	number	Какую строку множественного числа получать. `1` возвращает первую.
options	TranslateOptions	Дополнительные TranslateOptions

Возвращает

Переведённое сообщение

$rt(message, list, options)

Разрешить перевод сообщения локализации для интерполяции списка

Подпись:

typescript

$rt(message: MessageFunction<VueMessageType> | VueMessageType, list: unknown[], options?: TranslationOptions): string;

Подробности

Перегрузка $rt. Подробнее см. примечания к $rt.

Параметры

Параметр	Тип	Описание
message	MessageFunction<VueMessageType> \| VueMessageType	Целевое сообщение локализации для разрешения. Вам нужно указать сообщение локализации, возвращаемое `$tm`.
list	unknown[]	Значения интерполяции списка.
options	TranslateOptions	Дополнительные TranslateOptions

Возвращает

Переведённое сообщение

$rt(message, named, options)

Разрешить перевод сообщения локализации для интерполяции по имени

Подпись:

typescript

$rt(message: MessageFunction<VueMessageType> | VueMessageType, named: NamedValue, options?: TranslationOptions): string;

Подробности

Перегрузка $rt. Подробнее см. примечания к $rt.

Параметры

Параметр	Тип	Описание
message	MessageFunction<VueMessageType> \| VueMessageType	Целевое сообщение локализации для разрешения. Вам нужно указать сообщение локализации, возвращаемое `$tm`.
named	NamedValue	Значения интерполяции по имени.
options	TranslateOptions	Дополнительные TranslateOptions

Возвращает

Переведённое сообщение

$te(key, locale)

Наличие сообщения перевода

Подпись:

typescript

$te(key: Key, locale?: Locale): boolean;

Подробности

Подробнее см. VueI18n#te

Параметры

Параметр	Тип	Описание
key	Key	Ключ целевого сообщения локализации
locale	Locale	Необязательно, Локаль, переопределяющая локаль глобальной или локальной области видимости

Возвращает

Если сообщение локализации найдено, true, иначе false.

$tm(key)

Выбор сообщений локализации

Подпись:

typescript

$tm(key: Key): LocaleMessageValue<VueMessageType> | {}

Подробности

Если указаны опции компонента i18n, то предпочтительно получать локальные сообщения локализации вместо глобальных сообщений локализации.

Если опции компонента i18n не указаны, то получает сообщения локализации в глобальной области видимости.

На основе текущей локали, сообщения локализации будут возвращены из сообщений экземпляра Composer.

Если вы измените локаль, возвращаемые сообщения локализации также будут соответствовать этой локали.

Если в сообщениях экземпляра Composer нет сообщений локализации для заданного ключа, они будут возвращены с фолбэком.

Параметры

Параметр	Тип	Описание
key	Key	Ключ целевого сообщения локализации

Возвращает

Сообщения локализации

ПРИМЕЧАНИЕ

Для сообщений локализации, возвращённых $tm, необходимо использовать $rt.

$d(value)

Форматирование даты и времени

Подпись:

typescript

$d(value: number | Date): DateTimeFormatResult | string;

Подробности

Если используется в реактивном контексте, то будет пересчитано при изменении локали.

В режиме Composition API, входной/выходной формат аналогичен экземпляру VueI18n. Подробнее см. VueI18n#d.

В режиме Composition API, $d внедряется через app.config.globalProperties. Входной/выходной формат аналогичен экземпляру Composer, работает в глобальной области видимости. Подробнее см. Composer#d.

См. также

Параметры

Параметр	Тип	Описание
value	number \| Date	Значение, числовое значение времени или экземпляр `Date`

Возвращает

Отформатированное значение

$d(value, key)

Форматирование даты и времени

Подпись:

typescript

$d(value: number | Date, key: string): DateTimeFormatResult | string;

Подробности

Перегрузка $d. Подробнее см. примечания к $d.

Параметры

Параметр	Тип	Описание
value	number \| Date	Значение, числовое значение времени или экземпляр `Date`
key	string	Ключ форматов даты и времени

Возвращает

Отформатированное значение

$d(value, key, locale)

Форматирование даты и времени

Подпись:

typescript

$d(value: number | Date, key: string, locale: Locale): DateTimeFormatResult | string;

Подробности

Перегрузка $d. Подробнее см. примечания к $d.

Параметры

Параметр	Тип	Описание
value	number \| Date	Значение, числовое значение времени или экземпляр `Date`
key	string	Ключ форматов даты и времени
locale	Locale	Локаль, переопределяющая локаль глобальной или локальной области видимости

Возвращает

Отформатированное значение

$d(value, args)

Форматирование даты и времени

Подпись:

typescript

$d(value: number | Date, args: { [key: string]: string | boolean | number }): DateTimeFormatResult;

Подробности

Перегрузка $d. Подробнее см. примечания к $d.

Параметры

Параметр	Тип	Описание
value	number \| Date	Значение, числовое значение времени или экземпляр `Date`
args	{ [key: string]: string }	Значения аргументов

Возвращает

Отформатированное значение

$d(value, options)

Форматирование даты и времени

Подпись:

typescript

$d(value: number | Date, options: DateTimeOptions): string;

Подробности

Перегрузка $d. Подробнее см. примечания к $d.

Параметры

Параметр	Тип	Описание
value	number \| Date	Значение, числовое значение времени или экземпляр `Date`
options	DateTimeOptions	Параметры, см. DateTimeOptions

Возвращает

Отформатированное значение

$n(value)

Форматирование чисел

Подпись:

typescript

$n(value: number): NumberFormatResult | string;

Подробности

Если используется в реактивном контексте, то будет пересчитано при изменении локали.

В режиме Legacy API, входной/выходной формат аналогичен экземпляру VueI18n. Подробнее см. VueI18n#n.

В режиме Composition API, $n внедряется через app.config.globalProperties. Входной/выходной формат аналогичен экземпляру Composer, работает в глобальной области видимости. Подробнее см. Composer#n.

См. также

Параметры

Параметр	Тип	Описание
value	number	Числовое значение

Возвращает

Отформатированное значение

$n(value, key)

Форматирование чисел

Подпись:

typescript

$n(value: number, key: string): NumberFormatResult | string;

Подробности

Перегрузка $n. Подробнее см. примечания к $n.

Параметры

Параметр	Тип	Описание
value	number	Числовое значение
key	string	Ключ форматов чисел

Возвращает

Отформатированное значение

$n(value, key, locale)

Форматирование чисел

Подпись:

typescript

$n(value: number, key: string, locale: Locale): NumberFormatResult | string;

Подробности

Перегрузка $n. Подробнее см. примечания к $n.

Параметры

Параметр	Тип	Описание
value	number	Числовое значение
key	string	Ключ форматов чисел
locale	Locale	Локаль, переопределяющая локаль глобальной или локальной области видимости

Возвращает

Отформатированное значение

$n(value, args)

Форматирование чисел

Подпись:

typescript

$n(value: number, args: { [key: string]: string | boolean | number }): NumberFormatResult;

Подробности

Перегрузка $n. Подробнее см. примечания к $n.

Параметры

Параметр	Тип	Описание
value	number	Числовое значение
args	{ [key: string]: string }	Значения аргументов

Возвращает

Отформатированное значение

$n(value, key, args)

Форматирование чисел

Подпись:

typescript

$n(value: number, key: string, args: { [key: string]: string | boolean | number }): NumberFormatResult

Подробности

Перегрузка $n. Подробнее см. примечания к $n.

Параметры

Параметр	Тип	Описание
value	number	Числовое значение
key	string	Ключ форматов чисел
args	{ [key: string]: string }	Значения аргументов

Возвращает

Отформатированное значение

$n(value, key, locale, args)

Форматирование чисел

Подпись:

typescript

$n(value: number, key: string, locale: Locale, args: { [key: string]: string | boolean | number }): NumberFormatResult

Подробности

Перегрузка $n. Подробнее см. примечания к $n.

Параметры

Параметр	Тип	Описание
value	number	Числовое значение
key	string	Ключ форматов чисел
locale	Locale	Локаль, переопределяющая локаль глобальной или локальной области видимости
args	{ [key: string]: string }	Значения аргументов

Возвращает

Отформатированное значение

$n(value, options)

Форматирование чисел

Подпись:

typescript

$n(value: number, options: NumberOptions): string;

Подробности

Перегрузка $n. Подробнее см. примечания к $n.

Параметры

Параметр	Тип	Описание
value	number	Числовое значение
options	NumberOptions	Параметры, см. NumberOptions

Возвращает

Отформатированное значение

Внедрение компонентов ​

ComponentCustomOptions ​

i18n ​

ComponentCustomProperties ​

$i18n ​

$t(key) ​

Параметры ​

Возвращает ​

$t(key, locale) ​

Параметры ​

Возвращает ​

$t(key, locale, list) ​

Параметры ​

Возвращает ​

$t(key, locale, named) ​

Параметры ​

Возвращает ​

$t(key, plural) ​

Параметры ​

Возвращает ​

$t(key, plural, options) ​

Параметры ​

Возвращает ​

$t(key, defaultMsg) ​

Параметры ​

Возвращает ​

$t(key, defaultMsg, options) ​

Параметры ​

Возвращает ​

$t(key, list) ​

Параметры ​

Возвращает ​

$t(key, list, plural) ​

Параметры ​

Возвращает ​

$t(key, list, defaultMsg) ​

Параметры ​

Возвращает ​

$t(key, list, options) ​

Параметры ​

Возвращает ​

$t(key, named) ​

Параметры ​

Возвращает ​

$t(key, named, plural) ​

Параметры ​

Возвращает ​

$t(key, named, defaultMsg) ​

Параметры ​

Возвращает ​

$t(key, named, options) ​

Параметры ​

Возвращает ​

$rt(message) ​

Параметры ​

Возвращает ​

$rt(message, plural, options) ​

Параметры ​

Возвращает ​

$rt(message, list, options) ​

Параметры ​

Возвращает ​

$rt(message, named, options) ​

Параметры ​

Возвращает ​

$te(key, locale) ​

Параметры ​

Возвращает ​

$tm(key) ​

Параметры ​

Возвращает ​

$d(value) ​

Параметры ​

Возвращает ​

$d(value, key) ​

Параметры ​

Возвращает ​

$d(value, key, locale) ​

Параметры ​

Возвращает ​

Внедрение компонентов

ComponentCustomOptions

i18n

ComponentCustomProperties

$i18n

$t(key)

Параметры

Возвращает

$t(key, locale)

Параметры

Возвращает

$t(key, locale, list)

Параметры

Возвращает

$t(key, locale, named)

Параметры

Возвращает

$t(key, plural)

Параметры

Возвращает

$t(key, plural, options)

Параметры

Возвращает

$t(key, defaultMsg)

Параметры

Возвращает

$t(key, defaultMsg, options)

Параметры

Возвращает

$t(key, list)

Параметры

Возвращает

$t(key, list, plural)

Параметры

Возвращает

$t(key, list, defaultMsg)

Параметры

Возвращает

$t(key, list, options)

Параметры

Возвращает

$t(key, named)

Параметры

Возвращает

$t(key, named, plural)

Параметры

Возвращает

$t(key, named, defaultMsg)

Параметры

Возвращает

$t(key, named, options)

Параметры

Возвращает

$rt(message)

Параметры

Возвращает

$rt(message, plural, options)

Параметры

Возвращает

$rt(message, list, options)

Параметры

Возвращает

$rt(message, named, options)

Параметры

Возвращает

$te(key, locale)

Параметры

Возвращает

$tm(key)

Параметры

Возвращает

$d(value)

Параметры

Возвращает

$d(value, key)

Параметры

Возвращает

$d(value, key, locale)

Параметры

Возвращает