vue-i18n / general / Composer

Интерфейс: Composer<Messages, DateTimeFormats, NumberFormats, OptionLocale, ResourceLocales, Locales>

Интерфейсы Composer

Примечания

Это интерфейс для использования в Vue 3 Composition API.

Композиция Vue I18n

Расширяет

• ComposerCustom

Параметры типа

Параметр типа	Тип по умолчанию
Messages extends Record<string, any>	object
DateTimeFormats extends Record<string, any>	object
NumberFormats extends Record<string, any>	object
OptionLocale	Locale
ResourceLocales	| PickupLocales<NonNullable<Messages>> | PickupLocales<NonNullable<DateTimeFormats>> | PickupLocales<NonNullable<NumberFormats>>
Locales	Locale extends GeneratedLocale ? GeneratedLocale : OptionLocale extends Locale ? IsNever<ResourceLocales> extends true ? Locale : ResourceLocales : OptionLocale | ResourceLocales

Методы

getDateTimeFormat()

getDateTimeFormat<DateTimeSchema, LocaleSchema, Locale, Return>(locale): Return;

Получить формат даты и времени

Type Parameters

Type Parameter	Default type	Description
DateTimeSchema extends Record<string, any>	never	The datetime format schema, default never
LocaleSchema extends string	string	-
Locale extends string	PickupLocales<NonNullable<DateTimeFormats>>	-
Return	IsNever<DateTimeSchema> extends true ? IsEmptyObject<DateTimeFormats> extends true ? RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> : NonNullable<DateTimeFormats>[Locale] : DateTimeSchema	-

Parameters

Parameter	Type	Description
locale	LocaleSchema | Locale	A target locale

Возвращает

Return

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

Remarks

получить формат даты и времени из экземпляра Composer Composer#datetimeFormats.

---

getLocaleMessage()

getLocaleMessage<MessageSchema, LocaleSchema, Locale, Return>(locale): Return;

Получить локализованное сообщение

Type Parameters

Type Parameter	Default type	Description
MessageSchema extends LocaleMessage<VueMessageType>	never	The locale message schema, default never
LocaleSchema extends string	string	-
Locale extends string	PickupLocales<NonNullable<Messages>>	-
Return	IsNever<MessageSchema> extends true ? IsEmptyObject<Messages> extends true ? RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> : NonNullable<Messages>[Locale] : MessageSchema	-

Parameters

Parameter	Type	Description
locale	LocaleSchema | Locale	A target locale

Returns

Return

Locale messages

Remarks

получить локализованное сообщение из экземпляра Composer Composer#messages.

---

getMissingHandler()

getMissingHandler(): MissingHandler | null;

Получить обработчик отсутствующих элементов

See about:

• Composer#missing

Returns

MissingHandler | null

MissingHandler

---

getNumberFormat()

getNumberFormat<NumberSchema, LocaleSchema, Locale, Return>(locale): Return;

Получить формат числа

Type Parameters

Type Parameter	Default type	Description
NumberSchema extends Record<string, any>	never	The number format schema, default never
LocaleSchema extends string	string	-
Locale extends string	PickupLocales<NonNullable<NumberFormats>>	-
Return	IsNever<NumberSchema> extends true ? IsEmptyObject<NumberFormats> extends true ? RemoveIndexSignature<{ [key: string]: NumberFormatOptions; }> : NonNullable<NumberFormats>[Locale] : NumberSchema	-

Parameters

Parameter	Type	Description
locale	LocaleSchema | Locale	A target locale

Возвращает

Return

Формат числа

Remarks

get number format from Composer instance Composer#numberFormats.

---

getPostTranslationHandler()

getPostTranslationHandler(): 
  | PostTranslationHandler<VueMessageType>
  | null;

Получить обработчик постперевода

See about:

• Composer#missing

Returns

| PostTranslationHandler<VueMessageType> | null

PostTranslationHandler

---

mergeDateTimeFormat()

mergeDateTimeFormat<DateTimeSchema, LocaleSchema, Locale, Formats>(locale, format): void;

Merge datetime format

Type Parameters

Type Parameter	Default type	Description
DateTimeSchema extends Record<string, any>	never	The datetime format schema, default never
LocaleSchema extends string	string	-
Locale extends string	PickupLocales<NonNullable<DateTimeFormats>>	-
Formats	IsNever<DateTimeSchema> extends true ? Record<string, any> : DateTimeSchema	-

Parameters

Parameter	Type	Description
locale	LocaleSchema | Locale	A target locale
format	Formats	A target datetime format

Returns

void

Remarks

Merge datetime format to Composer instance Composer#datetimeFormats.

---

mergeLocaleMessage()

mergeLocaleMessage<MessageSchema, LocaleSchema, Locale, Message>(locale, message): void;

Merge locale message

Type Parameters

Type Parameter	Default type	Description
MessageSchema extends LocaleMessage<VueMessageType>	never	The locale message schema, default never
LocaleSchema extends string	string	-
Locale extends string	PickupLocales<NonNullable<Messages>>	-
Message	IsNever<MessageSchema> extends true ? Record<string, any> : MessageSchema	-

Parameters

Parameter	Type	Description
locale	LocaleSchema | Locale	A target locale
message	Message	A message

Returns

void

Remarks

Merge locale message to Composer instance Composer#messages.

---

mergeNumberFormat()

mergeNumberFormat<NumberSchema, LocaleSchema, Locale, Formats>(locale, format): void;

Merge number format

Type Parameters

Type Parameter	Default type	Description
NumberSchema extends Record<string, any>	never	The number format schema, default never
LocaleSchema extends string	string	-
Locale extends string	PickupLocales<NonNullable<NumberFormats>>	-
Formats	IsNever<NumberSchema> extends true ? Record<string, any> : NumberSchema	-

Parameters

Parameter	Type	Description
locale	LocaleSchema | Locale	A target locale
format	Formats	A target number format

Returns

void

Remarks

Merge number format to Composer instance Composer#numberFormats.

---

setDateTimeFormat()

setDateTimeFormat<DateTimeSchema, LocaleSchema, Locale, FormatsType, Formats>(locale, format): void;

Set datetime format

Type Parameters

Type Parameter	Default type	Description
DateTimeSchema extends Record<string, any>	never	The datetime format schema, default never
LocaleSchema extends string	string	-
Locale extends string	PickupLocales<NonNullable<DateTimeFormats>>	-
FormatsType	IsNever<DateTimeSchema> extends true ? IsEmptyObject<DateTimeFormats> extends true ? RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> : NonNullable<DateTimeFormats>[Locale] : DateTimeSchema	-
Formats	FormatsType	-

Parameters

Parameter	Type	Description
locale	LocaleSchema | Locale	A target locale
format	Formats	A target datetime format

Returns

void

Remarks

Set datetime format to Composer instance Composer#datetimeFormats.

---

setLocaleMessage()

setLocaleMessage<MessageSchema, LocaleSchema, Locale, MessageType, Message>(locale, message): void;

Set locale message

Type Parameters

Type Parameter	Default type	Description
MessageSchema extends LocaleMessage<VueMessageType>	never	The locale message schema, default never
LocaleSchema extends string	string	-
Locale extends string	PickupLocales<NonNullable<Messages>>	-
MessageType	IsNever<MessageSchema> extends true ? IsEmptyObject<Messages> extends true ? RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> : NonNullable<Messages>[Locale] : MessageSchema	-
Message	MessageType	-

Parameters

Parameter	Type	Description
locale	LocaleSchema | Locale	A target locale
message	Message	A message

Returns

void

Remarks

Set locale message to Composer instance Composer#messages.

---

setMissingHandler()

setMissingHandler(handler): void;

Set missing handler

See about:

• Composer#missing

Parameters

Parameter	Type	Description
handler	MissingHandler | null	A MissingHandler

Returns

void

---

setNumberFormat()

setNumberFormat<NumberSchema, LocaleSchema, Locale, FormatsType, Formats>(locale, format): void;

Set number format

Type Parameters

Type Parameter	Default type	Description
NumberSchema extends Record<string, any>	never	The number format schema, default never
LocaleSchema extends string	string	-
Locale extends string	PickupLocales<NonNullable<NumberFormats>>	-
FormatsType	IsNever<NumberSchema> extends true ? IsEmptyObject<NumberFormats> extends true ? RemoveIndexSignature<{ [key: string]: NumberFormatOptions; }> : NonNullable<NumberFormats>[Locale] : NumberSchema	-
Formats	FormatsType	-

Parameters

Parameter	Type	Description
locale	LocaleSchema | Locale	A target locale
format	Formats	A target number format

Returns

void

Remarks

Set number format to Composer instance Composer#numberFormats.

---

setPostTranslationHandler()

setPostTranslationHandler(handler): void;

Set post translation handler

See about:

• Composer#missing

Parameters

Parameter	Type	Description
handler	| PostTranslationHandler<VueMessageType> | null	A PostTranslationHandler

Returns

void

---

te()

te<Str, Key>(key, locale?): boolean;

Translation locale message exist

Type Parameters

Type Parameter	Default type
Str extends string	-
Key extends string | number | symbol	PickupKeys<Messages>

Parameters

Parameter	Type	Description
key	Str | Key	A target locale message key
locale?	Locales	A locale, it will be used over than global scope or local scope

Returns

boolean

If found locale message, true, else false, Note that false is returned even if the value present in the key is not translatable, yet if translateExistCompatible is set to true, it will return true if the key is available, even if the value is not translatable.

Remarks

whether do exist locale message on Composer instance Composer#messages.

If you specified locale, check the locale messages of locale.

---

tm()

tm<Key, ResourceKeys, Locale, Target, Return>(key): Return;

Locale messages getter

Type Parameters

Type Parameter	Default type
Key extends string	-
ResourceKeys extends string | number | symbol	PickupKeys<Messages>
Locale extends string	PickupLocales<NonNullable<Messages>>
Target	IsEmptyObject<Messages> extends false ? NonNullable<Messages>[Locale] : RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
Return	ResourceKeys extends ResourcePath<Target> ? ResourceValue<Target, ResourceKeys<ResourceKeys>> : Record<string, any>

Parameters

Parameter	Type	Description
key	Key | ResourceKeys	A target locale message key

Returns

Return

Locale messages

Remarks

If I18nScope 'local' or Some UseI18nOptions are specified at useI18n, it’s translated in preferentially local scope locale messages than global scope locale messages.

Based on the current locale, locale messages will be returned from Composer instance messages.

If you change the locale, the locale messages returned will also correspond to the locale.

If there are no locale messages for the given key in the composer instance messages, they will be returned with fallbacking.

WARNING

You need to use rt for the locale message returned by tm. see the rt details.

Example

template block:

<div class="container">
  <template v-for="content in tm('contents')">
    <h2>{{ rt(content.title) }}</h2>
    <p v-for="paragraph in content.paragraphs">
     {{ rt(paragraph) }}
    </p>
  </template>
</div>

script block:

import { defineComponent } from 'vue
import { useI18n } from 'vue-i18n'

export default defineComponent({
  setup() {
    const { rt, tm } = useI18n({
      messages: {
        en: {
          contents: [
            {
              title: 'Title1',
              // ...
              paragraphs: [
                // ...
              ]
            }
          ]
        }
      }
      // ...
    })
    // ...
    return { ... , rt, tm }
  }
})

Свойства

availableLocales

readonly availableLocales: ComputedRef<Locales[]>;

Remarks

Список доступных локалей в messages в лексикографическом порядке.

---

d

d: ComposerDateTimeFormatting<DateTimeFormats, Locales, RemoveIndexSignature<{
[key: string]: DateTimeFormatOptions;
}>>;

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

Remarks

За подробными функциями обращайтесь к ComposerDateTimeFormatting

---

datetimeFormats

readonly datetimeFormats: ComputedRef<{ [K in string | number | symbol]: DateTimeFormats[K] }>;

Remarks

Форматы даты и времени локализации.

See about:

• Datetime Formatting

---

escapeParameter

escapeParameter: boolean;

Remarks

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

See about:

• HTML Message

---

fallbackFormat

fallbackFormat: boolean;

Remarks

Указывает, следует ли подавлять предупреждения при возврате к fallbackLocale или корневому уровню.

See about:

• Fallbacking

---

fallbackLocale

fallbackLocale: WritableComputedRef<FallbackLocales<Locales>>;

Remarks

Текущие резервные локали, используемые этим экземпляром Composer.

See about:

• Fallbacking

---

fallbackRoot

fallbackRoot: boolean;

Remarks

Следует ли возвращаться к глобальной области (корневому уровню) локализации при неудачной локализации.

See about:

• Fallbacking

---

fallbackWarn

fallbackWarn: boolean | RegExp;

Remarks

Следует ли подавлять предупреждения о возврате при неудачной локализации.

See about:

• Fallbacking

---

id

id: number;

Remarks

ID экземпляра.

---

inheritLocale

inheritLocale: boolean;

Remarks

Следует ли наследовать уровень локали корня к локали локализации компонента.

See about:

• Local Scope

---

isGlobal

readonly isGlobal: boolean;

Remarks

Является ли этот экземпляр composer глобальным или нет

---

locale

locale: WritableComputedRef<Locales>;

Remarks

Текущая локаль, используемая этим экземпляром Composer.

If the locale contains a territory and a dialect, this locale contains an implicit fallback.

See about:

• Scope and Locale Changing

---

messages

readonly messages: ComputedRef<{ [K in string | number | symbol]: Messages[K] }>;

Remarks

Локализованные сообщения.

See about:

• Getting Started

---

missingWarn

missingWarn: boolean | RegExp;

Remarks

Следует ли подавлять предупреждения, выводимые при неудачной локализации.

See about:

• Fallbacking

---

modifiers

readonly modifiers: LinkedModifiers<VueMessageType>;

Remarks

Пользовательские модификаторы для связанных сообщений.

See about:

• Custom Modifiers

---

n

n: ComposerNumberFormatting<NumberFormats, Locales, RemoveIndexSignature<{
[key: string]: NumberFormatOptions;
}>>;

Number Formatting

Remarks

За подробными функциями обращайтесь к ComposerNumberFormatting

---

numberFormats

readonly numberFormats: ComputedRef<{ [K in string | number | symbol]: NumberFormats[K] }>;

Remarks

Форматы чисел локализации.

See about:

• Number Formatting

---

pluralRules

readonly pluralRules: PluralizationRules;

Remarks

Набор правил для словесного множественного числа

See about:

• Custom Pluralization

---

rt

rt: ComposerResolveLocaleMessageTranslation<Locales>;

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

Remarks

About details functions, See the ComposerResolveLocaleMessageTranslation

---

t

t: ComposerTranslation<Messages, Locales, RemoveIndexSignature<{
[key: string]: LocaleMessageValue<VueMessageType>;
}>>;

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

Remarks

About details functions, See the ComposerTranslation

---

warnHtmlMessage

warnHtmlMessage: boolean;

Remarks

Следует ли разрешать использование локализованных сообщений с форматированием HTML.

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

Если вы установите true, предупреждение будет выведено в консоль.

See about:

• HTML Message
• Change warnHtmlInMessage option default value