vue-i18n / general / Composer

インターフェース: Composer<Messages, DateTimeFormats, NumberFormats, OptionLocale, ResourceLocales, Locales>

Composer インターフェース

備考

これは Vue 3 Composition API で使用されるインターフェースです。

Vue I18n Composition

継承

• 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;

日時形式を取得

型パラメータ

型パラメータ	デフォルト型	説明
DateTimeSchema extends Record<string, any>	never	日時形式スキーマ、デフォルトは 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	-

パラメータ

パラメータ	型	説明
locale	LocaleSchema | Locale	対象ロケール

戻り値

Return

日時形式

備考

Composer インスタンスから日時形式を取得 Composer#datetimeFormats。

---

getLocaleMessage()

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

ロケールメッセージを取得

型パラメータ

型パラメータ	デフォルト型	説明
MessageSchema extends LocaleMessage<VueMessageType>	never	ロケールメッセージスキーマ、デフォルトは 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	-

パラメータ

パラメータ	型	説明
locale	LocaleSchema | Locale	対象ロケール

戻り値

Return

ロケールメッセージ

備考

Composer インスタンスからロケールメッセージを取得 Composer#messages。

---

getMissingHandler()

getMissingHandler(): MissingHandler | null;

不足ハンドラーを取得

詳しくは次を参照:

• Composer#missing

戻り値

MissingHandler | null

MissingHandler

---

getNumberFormat()

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

数値形式を取得

型パラメータ

型パラメータ	デフォルト型	説明
NumberSchema extends Record<string, any>	never	数値形式スキーマ、デフォルトは 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	-

パラメータ

パラメータ	型	説明
locale	LocaleSchema | Locale	対象ロケール

戻り値

Return

数値形式

備考

Composer インスタンスに数値形式をマージ Composer#numberFormats。

---

getPostTranslationHandler()

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

翻訳後処理ハンドラーを取得

詳しくは次を参照:

• Composer#missing

戻り値

| PostTranslationHandler<VueMessageType> | null

PostTranslationHandler

---

mergeDateTimeFormat()

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

日時形式をマージ

型パラメータ

型パラメータ	デフォルト型	説明
DateTimeSchema extends Record<string, any>	never	日時形式スキーマ、デフォルトは never
LocaleSchema extends string	string	-
Locale extends string	PickupLocales<NonNullable<DateTimeFormats>>	-
Formats	IsNever<DateTimeSchema> extends true ? Record<string, any> : DateTimeSchema	-

パラメータ

パラメータ	型	説明
locale	LocaleSchema | Locale	対象ロケール
format	Formats	対象日時形式

戻り値

void

備考

Composer インスタンスに日時形式をマージ Composer#datetimeFormats。

---

mergeLocaleMessage()

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

ロケールメッセージをマージ

型パラメータ

型パラメータ	デフォルト型	説明
MessageSchema extends LocaleMessage<VueMessageType>	never	ロケールメッセージスキーマ、デフォルトは never
LocaleSchema extends string	string	-
Locale extends string	PickupLocales<NonNullable<Messages>>	-
Message	IsNever<MessageSchema> extends true ? Record<string, any> : MessageSchema	-

パラメータ

パラメータ	型	説明
locale	LocaleSchema | Locale	対象ロケール
message	Message	メッセージ

戻り値

void

備考

Composer インスタンスにロケールメッセージをマージ Composer#messages。

---

mergeNumberFormat()

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

数値形式をマージ

型パラメータ

型パラメータ	デフォルト型	説明
NumberSchema extends Record<string, any>	never	数値形式スキーマ、デフォルトは never
LocaleSchema extends string	string	-
Locale extends string	PickupLocales<NonNullable<NumberFormats>>	-
Formats	IsNever<NumberSchema> extends true ? Record<string, any> : NumberSchema	-

パラメータ

パラメータ	型	説明
locale	LocaleSchema | Locale	対象ロケール
format	Formats	対象数値形式

戻り値

void

備考

Composer インスタンスに数値形式をマージ Composer#numberFormats。

---

setDateTimeFormat()

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

日時形式を設定

型パラメータ

型パラメータ	デフォルト型	説明
DateTimeSchema extends Record<string, any>	never	日時形式スキーマ、デフォルトは 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	-

パラメータ

パラメータ	型	説明
locale	LocaleSchema | Locale	対象ロケール
format	Formats	対象日時形式

戻り値

void

備考

Composer インスタンスに日時形式を設定 Composer#datetimeFormats。

---

setLocaleMessage()

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

ロケールメッセージを設定

型パラメータ

型パラメータ	デフォルト型	説明
MessageSchema extends LocaleMessage<VueMessageType>	never	ロケールメッセージスキーマ、デフォルトは 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	-

パラメータ

パラメータ	型	説明
locale	LocaleSchema | Locale	対象ロケール
message	Message	メッセージ

戻り値

void

備考

Composer インスタンスにロケールメッセージを設定 Composer#messages。

---

setMissingHandler()

setMissingHandler(handler): void;

不足ハンドラーを設定

詳しくは次を参照:

• Composer#missing

パラメータ

パラメータ	型	説明
handler	MissingHandler | null	MissingHandler

戻り値

void

---

setNumberFormat()

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

数値形式を設定

型パラメータ

型パラメータ	デフォルト型	説明
NumberSchema extends Record<string, any>	never	数値形式スキーマ、デフォルトは 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	-

パラメータ

パラメータ	型	説明
locale	LocaleSchema | Locale	対象ロケール
format	Formats	対象数値形式

戻り値

void

備考

Composer インスタンスに数値形式を設定 Composer#numberFormats。

---

setPostTranslationHandler()

setPostTranslationHandler(handler): void;

翻訳後処理ハンドラーを設定

詳しくは次を参照:

• Composer#missing

パラメータ

パラメータ	型	説明
handler	| PostTranslationHandler<VueMessageType> | null	PostTranslationHandler

戻り値

void

---

te()

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

翻訳対象のロケールメッセージが存在するか

型パラメータ

型パラメータ	デフォルト型
Str extends string	-
Key extends string | number | symbol	PickupKeys<Messages>

パラメータ

パラメータ	型	説明
key	Str | Key	対象ロケールメッセージキー
locale?	Locales	ロケール、グローバルスコープまたはローカルスコープより優先的に使用される

戻り値

boolean

ロケールメッセージが見つかった場合は true、それ以外は false。キーの値が翻訳可能でない場合でも false を返すことに注意してください。ただし、translateExistCompatible が true に設定されている場合、値が翻訳可能でなくてもキーが利用可能な限り true を返します。

備考

Composer インスタンスのロケールメッセージが存在するか確認 Composer#messages。

locale が指定された場合、locale のロケールメッセージをチェックします。

---

tm()

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

ロケールメッセージ取得

型パラメータ

型パラメータ	デフォルト型
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>

パラメータ

パラメータ	型	説明
key	Key | ResourceKeys	対象ロケールメッセージキー

戻り値

Return

ロケールメッセージ

備考

I18nScope 'local' または useI18n でいくつかの UseI18nOptions が指定された場合、グローバルスコープのロケールメッセージよりもローカルスコープのロケールメッセージが優先的に翻訳されます。

現在の locale に基づいて、Composer インスタンスのメッセージからロケールメッセージが返されます。

locale を変更すると、返されるロケールメッセージも対応して変更されます。

composer インスタンスのメッセージに指定された key のロケールメッセージがない場合は、フォールバックを使用して返されます。

WARNING

tm によって返されるロケールメッセージには rt を使用する必要があります。rt の詳細を確認してください。

例

テンプレートブロック:

<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>

スクリプトブロック:

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[]>;

備考

messages 内で利用可能なロケールのリスト（語彙順）。

---

d

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

日時フォーマット

備考

詳細な関数については、ComposerDateTimeFormattingを参照してください。

---

datetimeFormats

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

備考

ローカリゼーションの日時形式。

詳しくは次を参照:

• 日時フォーマット

---

escapeParameter

escapeParameter: boolean;

備考

メッセージが翻訳される前に、補間パラメータをエスケープするかどうか。

詳しくは次を参照:

• HTMLメッセージ

---

fallbackFormat

fallbackFormat: boolean;

備考

fallbackLocale またはルートへフォールバックする際に警告を抑制するかどうか。

詳しくは次を参照:

• フォールバック

---

fallbackLocale

fallbackLocale: WritableComputedRef<FallbackLocales<Locales>>;

備考

このComposerインスタンスが使用している現在のフォールバックロケール。

詳しくは次を参照:

• フォールバック

---

fallbackRoot

fallbackRoot: boolean;

備考

ローカリゼーションに失敗したときに、ルートレベル（グローバルスコープ）のローカリゼーションにフォールバックするかどうか。

詳しくは次を参照:

• フォールバック

---

fallbackWarn

fallbackWarn: boolean | RegExp;

備考

ローカリゼーションに失敗したときにフォールバック警告を抑制するかどうか。

詳しくは次を参照:

• フォールバック

---

id

id: number;

備考

インスタンスID。

---

inheritLocale

inheritLocale: boolean;

備考

コンポーネントローカライズロケールにルートレベルロケールを継承するかどうか。

詳しくは次を参照:

• ローカルスコープ

---

isGlobal

readonly isGlobal: boolean;

備考

このcomposerインスタンスがグローバルかどうか

---

locale

locale: WritableComputedRef<Locales>;

備考

このComposerインスタンスが使用している現在のロケール。

ロケールに地域と方言が含まれている場合、このロケールには暗黙的なフォールバックが含まれます。

詳しくは次を参照:

• スコープとロケール変更

---

messages

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

備考

ローカリゼーションのロケールメッセージ。

詳しくは次を参照:

• 入門

---

missingWarn

missingWarn: boolean | RegExp;

備考

ローカリゼーションに失敗した際に警告を抑制するかどうか。

詳しくは次を参照:

• フォールバック

---

modifiers

readonly modifiers: LinkedModifiers<VueMessageType>;

備考

リンクされたメッセージ用のカスタム修飾子。

詳しくは次を参照:

• カスタム修飾子

---

n

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

数値フォーマット

備考

詳細な関数については、ComposerNumberFormattingを参照してください。

---

numberFormats

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

備考

ローカリゼーションの数値形式。

詳しくは次を参照:

• 数値フォーマット

---

pluralRules

readonly pluralRules: PluralizationRules;

備考

単語の複数形規則セット

詳しくは次を参照:

• カスタム複数形

---

rt

rt: ComposerResolveLocaleMessageTranslation<Locales>;

ロケールメッセージ翻訳を解決

備考

詳細な関数については、ComposerResolveLocaleMessageTranslationを参照してください。

---

t

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

ロケールメッセージ翻訳

備考

詳細な関数については、ComposerTranslationを参照してください。

---

warnHtmlMessage

warnHtmlMessage: boolean;

備考

HTML形式のロケールメッセージの使用を許可するかどうか。

false を設定した場合、Composerインスタンスのロケールメッセージをチェックします。

true を指定した場合、コンソールに出力されます。

詳しくは次を参照:

• HTMLメッセージ
• Change warnHtmlInMessage option default value