vue-i18n / vue / ComponentCustomProperties
インターフェース: ComponentCustomProperties
Vue I18n のコンポーネントカスタムプロパティ
Vue I18n の注入
メソッド
$d()
呼び出しシグネチャ
ts
$d(value): string;日時形式のフォーマット
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
value | string | number | Date | 値、タイムスタンプ数または Date インスタンス |
戻り値
string
形式化された値
備考
これは反応型コンテキストで使用されている場合、ロケールが変更されると一度再評価されます。
I18nMode | Composition API モードでは、$d は app.config.globalProperties によって注入されます。 入力/出力は Composer インスタンスと同じであり、グローバルスコープで動作します。詳細については、Composer#d | `Composer#d` を参照してください。
呼び出しシグネチャ
ts
$d<Value, Key, DefinedDateTimeFormat, Keys, ResourceKeys>(value, key): string;日時形式のフォーマット
ジェネリック型パラメータ
| ジェネリック型パラメータ | デフォルト型 |
|---|---|
Value extends string | number | Date | number |
Key extends string | string |
DefinedDateTimeFormat extends RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> | RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> |
Keys | IsEmptyObject<DefinedDateTimeFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedDateTimeFormat[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
value | Value | 値、タイムスタンプ数または Date インスタンス |
key | Key | ResourceKeys | 日時形式のキー |
戻り値
string
形式化された値
備考
オーバーロードされた $d。詳細については、$d の備考を参照してください。
呼び出しシグネチャ
ts
$d<Value, Key, DefinedDateTimeFormat, Keys, ResourceKeys>(value, options): string;日時形式のフォーマット
ジェネリック型パラメータ
| ジェネリック型パラメータ | デフォルト型 |
|---|---|
Value extends string | number | Date | number |
Key extends string | string |
DefinedDateTimeFormat extends RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> | RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> |
Keys | IsEmptyObject<DefinedDateTimeFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedDateTimeFormat[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
value | Value | 値、タイムスタンプ数または Date インスタンス |
options | DateTimeOptions<Key | ResourceKeys> | options |
戻り値
string
形式化された値
備考
オーバーロードされた $d。詳細については、$d の備考を参照してください。
呼び出しシグネチャ
ts
$d<Value, Key, DefinedDateTimeFormat, Keys, ResourceKeys>(
value,
key,
locale): string;日時形式のフォーマット
ジェネリック型パラメータ
| ジェネリック型パラメータ | デフォルト型 |
|---|---|
Value extends string | number | Date | number |
Key extends string | string |
DefinedDateTimeFormat extends RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> | RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> |
Keys | IsEmptyObject<DefinedDateTimeFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedDateTimeFormat[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
value | Value | 値、タイムスタンプ数または Date インスタンス |
key | Key | ResourceKeys | 日時形式のキー |
locale | string | ロケール、オプション。グローバルスコープまたはローカルスコープのロケールを上書き |
戻り値
string
形式化された値
備考
オーバーロードされた $d。詳細については、$d の備考を参照してください。
呼び出しシグネチャ
ts
$d<Value, Key, DefinedDateTimeFormat, Keys, ResourceKeys, OptionsType>(
value,
options,
locale): IsPart<OptionsType> extends true ? DateTimeFormatPart[] : string;日時形式のフォーマット
ジェネリック型パラメータ
| ジェネリック型パラメータ | デフォルト型 |
|---|---|
Value extends number | Date | number |
Key extends string | string |
DefinedDateTimeFormat extends RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> | RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> |
Keys | IsEmptyObject<DefinedDateTimeFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedDateTimeFormat[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
OptionsType | DateTimeOptions<Key | ResourceKeys, string> |
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
value | Value | 値、タイムスタンプ数または Date インスタンス |
options | OptionsType | options |
locale | string | ロケール、オプション。グローバルスコープまたはローカルスコープのロケールを上書き |
戻り値
IsPart<OptionsType> extends true ? DateTimeFormatPart[] : string
形式化された値
備考
オーバーロードされた $d。詳細については、$d の備考を参照してください。
$n()
呼び出しシグネチャ
ts
$n(value): string;数値形式のフォーマット
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
value | number | 数値 |
戻り値
string
形式化された値
備考
これは反応型コンテキストで使用されている場合、ロケールが変更されると一度再評価されます。
I18nMode | Composition API モードでは、$n は app.config.globalProperties によって注入されます。 入力/出力は Composer インスタンスと同じであり、グローバルスコープで動作します。詳細については、Composer#n | `Composer.n` を参照してください。
呼び出しシグネチャ
ts
$n<Key, DefinedNumberFormat, Keys, ResourceKeys>(value, key): string;数値形式のフォーマット
ジェネリック型パラメータ
| ジェネリック型パラメータ | デフォルト型 |
|---|---|
Key extends string | string |
DefinedNumberFormat extends RemoveIndexSignature<{ [key: string]: NumberFormatOptions; }> | RemoveIndexSignature<{ [key: string]: NumberFormatOptions; }> |
Keys | IsEmptyObject<DefinedNumberFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedNumberFormat[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
value | number | 数値 |
key | Key | ResourceKeys | 数値形式のキー |
戻り値
string
形式化された値
備考
オーバーロードされた $n。詳細については、$n の備考を参照してください。
呼び出しシグネチャ
ts
$n<Key, DefinedNumberFormat, Keys, ResourceKeys, OptionsType>(value, options): IsPart<OptionsType> extends true ? NumberFormatPart[] : string;数値形式のフォーマット
ジェネリック型パラメータ
| ジェネリック型パラメータ | デフォルト型 |
|---|---|
Key extends string | string |
DefinedNumberFormat extends RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> | RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> |
Keys | IsEmptyObject<DefinedNumberFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedNumberFormat[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
OptionsType | NumberOptions<Key | ResourceKeys, string> |
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
value | number | 数値 |
options | OptionsType | オプション。NumberOptions を参照してください |
戻り値
IsPart<OptionsType> extends true ? NumberFormatPart[] : string
形式化された値
備考
オーバーロードされた $n。詳細については、$n の備考を参照してください。
呼び出しシグネチャ
ts
$n<Key, DefinedNumberFormat, Keys, ResourceKeys>(
value,
key,
locale): string;数値形式のフォーマット
ジェネリック型パラメータ
| ジェネリック型パラメータ | デフォルト型 |
|---|---|
Key extends string | string |
DefinedNumberFormat extends RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> | RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> |
Keys | IsEmptyObject<DefinedNumberFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedNumberFormat[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
value | number | 数値 |
key | Key | ResourceKeys | 数値形式のキー |
locale | string | ロケール、オプション。グローバルスコープまたはローカルスコープのロケールを上書き |
戻り値
string
形式化された値
備考
オーバーロードされた $n。詳細については、$n の備考を参照してください。
呼び出しシグネチャ
ts
$n<Key, DefinedNumberFormat, Keys, ResourceKeys, OptionsType>(
value,
options,
locale): IsPart<OptionsType> extends true ? NumberFormatPart[] : string;数値形式のフォーマット
ジェネリック型パラメータ
| ジェネリック型パラメータ | デフォルト型 |
|---|---|
Key extends string | string |
DefinedNumberFormat extends RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> | RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> |
Keys | IsEmptyObject<DefinedNumberFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedNumberFormat[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
OptionsType | NumberOptions<Key | ResourceKeys, string> |
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
value | number | 数値 |
options | OptionsType | オプション。NumberOptions を参照してください |
locale | string | ロケール、オプション。グローバルスコープまたはローカルスコープのロケールを上書き |
戻り値
IsPart<OptionsType> extends true ? NumberFormatPart[] : string
形式化された値
備考
オーバーロードされた $n。詳細については、$n の備考を参照してください。
$rt()
呼び出しシグネチャ
ts
$rt(message): string;ロケールメッセージの翻訳解決
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
message | | VueMessageType | MessageFunction<VueMessageType> | 解決するターゲットロケールメッセージ。$tm によって返されるロケールメッセージを指定する必要があります。 |
戻り値
string
翻訳されたメッセージ
備考
これは反応型コンテキストで使用されている場合、ロケールが変更されると一度再評価されます。
I18nMode | Composition API モードでは、$rt は app.config.globalProperties によって注入されます。 入力/出力は Composer と同じであり、グローバルスコープで動作します。詳細については、Composer#rt | `Composer#rt` を参照してください。
呼び出しシグネチャ
ts
$rt(
message,
plural,
options?): string;複数形のロケールメッセージ翻訳解決
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
message | | VueMessageType | MessageFunction<VueMessageType> | 解決するターゲットロケールメッセージ。$tm によって返されるロケールメッセージを指定する必要があります。 |
plural | number | 取得する複数形文字列。1は最初のものを返します。 |
options? | TranslateOptions<string> | 翻訳用追加オプション |
戻り値
string
翻訳されたメッセージ
備考
オーバーロードされた $rt。詳細については、$rt の備考を参照してください。
呼び出しシグネチャ
ts
$rt(
message,
list,
options?): string;リスト補完のロケールメッセージ翻訳解決
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
message | | VueMessageType | MessageFunction<VueMessageType> | 解決するターゲットロケールメッセージ。$tm によって返されるロケールメッセージを指定する必要があります。 |
list | unknown[] | リスト補完値。 |
options? | TranslateOptions<string> | 翻訳用追加オプション |
戻り値
string
翻訳されたメッセージ
備考
オーバーロードされた $rt。詳細については、$rt の備考を参照してください。
呼び出しシグネチャ
ts
$rt(
message,
named,
options?): string;名前付き補完のロケールメッセージ翻訳解決
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
message | | VueMessageType | MessageFunction<VueMessageType> | 解決するターゲットロケールメッセージ。$tm によって返されるロケールメッセージを指定する必要があります。 |
named | NamedValue | 名前付き補完値。 |
options? | TranslateOptions<string> | 翻訳用追加オプション |
戻り値
string
翻訳されたメッセージ
備考
オーバーロードされた $rt。詳細については、$rt の備考を参照してください。
$t()
呼び出しシグネチャ
ts
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(key): string;ロケールメッセージ翻訳
ジェネリック型パラメータ
| ジェネリック型パラメータ | デフォルト型 |
|---|---|
Key extends string | - |
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> | RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> |
Keys | IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
key | number | Key | ResourceKeys | ターゲットロケールメッセージキー |
戻り値
string
翻訳メッセージ
備考
これは反応型コンテキストで使用されている場合、ロケールが変更されると一度再評価されます。
I18nMode | Composition API モードでは、$t は app.config.globalProperties によって注入されます。 入力/出力は Composer と同じであり、グローバルスコープで動作します。詳細については、Composer#t | `Composer#t` を参照してください。
呼び出しシグネチャ
ts
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(key, plural): string;ロケールメッセージ翻訳
ジェネリック型パラメータ
| ジェネリック型パラメータ | デフォルト型 |
|---|---|
Key extends string | - |
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> | RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> |
Keys | IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
key | number | Key | ResourceKeys | ターゲットロケールメッセージキー |
plural | number | 複数形の選択番号 |
戻り値
string
翻訳メッセージ
備考
オーバーロードされた $t。詳細については、$t の備考を参照してください。
呼び出しシグネチャ
ts
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
key,
plural,
options): string;ロケールメッセージ翻訳
ジェネリック型パラメータ
| ジェネリック型パラメータ | デフォルト型 |
|---|---|
Key extends string | - |
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> | RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> |
Keys | IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
key | number | Key | ResourceKeys | ターゲットロケールメッセージキー |
plural | number | 取得する複数形文字列。1は最初のものを返します。 |
options | TranslateOptions | オプション。TranslateOptions を参照してください |
戻り値
string
翻訳メッセージ
備考
オーバーロードされた $t。詳細については、$t の備考を参照してください。
呼び出しシグネチャ
ts
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(key, defaultMsg): string;ロケールメッセージ翻訳
ジェネリック型パラメータ
| ジェネリック型パラメータ | デフォルト型 |
|---|---|
Key extends string | - |
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> | RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> |
Keys | IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
key | number | Key | ResourceKeys | ターゲットロケールメッセージキー |
defaultMsg | string | 翻訳がない場合に返すデフォルトメッセージ |
戻り値
string
翻訳メッセージ
備考
オーバーロードされた $t。詳細については、$t の備考を参照してください。
呼び出しシグネチャ
ts
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
key,
defaultMsg,
options): string;ロケールメッセージ翻訳
ジェネリック型パラメータ
| ジェネリック型パラメータ | デフォルト型 |
|---|---|
Key extends string | - |
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> | RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> |
Keys | IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
key | number | Key | ResourceKeys | ターゲットロケールメッセージキー |
defaultMsg | string | 翻訳がない場合に返すデフォルトメッセージ |
options | TranslateOptions | オプション。TranslateOptions を参照してください |
戻り値
string
翻訳メッセージ
備考
オーバーロードされた $t。詳細については、$t の備考を参照してください。
呼び出しシグネチャ
ts
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(key, list): string;ロケールメッセージ翻訳
ジェネリック型パラメータ
| ジェネリック型パラメータ | デフォルト型 |
|---|---|
Key extends string | - |
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> | RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> |
Keys | IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
key | number | Key | ResourceKeys | ターゲットロケールメッセージキー |
list | unknown[] | リスト補完値 |
戻り値
string
翻訳メッセージ
備考
オーバーロードされた $t。詳細については、$t の備考を参照してください。
呼び出しシグネチャ
ts
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
key,
list,
plural): string;ロケールメッセージ翻訳
ジェネリック型パラメータ
| ジェネリック型パラメータ | デフォルト型 |
|---|---|
Key extends string | - |
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> | RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> |
Keys | IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
key | number | Key | ResourceKeys | ターゲットロケールメッセージキー |
list | unknown[] | リスト補完値 |
plural | number | 複数形の選択番号 |
戻り値
string
翻訳メッセージ
備考
オーバーロードされた $t。詳細については、$t の備考を参照してください。
呼び出しシグネチャ
ts
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
key,
list,
defaultMsg): string;ロケールメッセージ翻訳
ジェネリック型パラメータ
| ジェネリック型パラメータ | デフォルト型 |
|---|---|
Key extends string | - |
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> | RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> |
Keys | IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
key | number | Key | ResourceKeys | ターゲットロケールメッセージキー |
list | unknown[] | リスト補完値 |
defaultMsg | string | 翻訳がない場合に返すデフォルトメッセージ |
戻り値
string
翻訳メッセージ
備考
オーバーロードされた $t。詳細については、$t の備考を参照してください。
呼び出しシグネチャ
ts
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
key,
list,
options): string;ロケールメッセージ翻訳
ジェネリック型パラメータ
| ジェネリック型パラメータ | デフォルト型 |
|---|---|
Key extends string | - |
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> | RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> |
Keys | IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
key | number | Key | ResourceKeys | ターゲットロケールメッセージキー |
list | unknown[] | リスト補完値 |
options | TranslateOptions | オプション。TranslateOptions を参照してください |
戻り値
string
翻訳メッセージ
備考
オーバーロードされた $t。詳細については、$t の備考を参照してください。
呼び出しシグネチャ
ts
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(key, named): string;ロケールメッセージ翻訳
ジェネリック型パラメータ
| ジェネリック型パラメータ | デフォルト型 |
|---|---|
Key extends string | - |
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> | RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> |
Keys | IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
key | number | Key | ResourceKeys | ターゲットロケールメッセージキー |
named | NamedValue | 名前付き補完値 |
戻り値
string
翻訳メッセージ
備考
オーバーロードされた $t。詳細については、$t の備考を参照してください。
呼び出しシグネチャ
ts
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
key,
named,
plural): string;ロケールメッセージ翻訳
ジェネリック型パラメータ
| ジェネリック型パラメータ | デフォルト型 |
|---|---|
Key extends string | - |
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> | RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> |
Keys | IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
key | number | Key | ResourceKeys | ターゲットロケールメッセージキー |
named | NamedValue | 名前付き補完値 |
plural | number | 複数形の選択番号 |
戻り値
string
翻訳メッセージ
備考
オーバーロードされた $t。詳細については、$t の備考を参照してください。
呼び出しシグネチャ
ts
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
key,
named,
defaultMsg): string;ロケールメッセージ翻訳
ジェネリック型パラメータ
| ジェネリック型パラメータ | デフォルト型 |
|---|---|
Key extends string | - |
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> | RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> |
Keys | IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
key | number | Key | ResourceKeys | ターゲットロケールメッセージキー |
named | NamedValue | 名前付き補完値 |
defaultMsg | string | 翻訳がない場合に返すデフォルトメッセージ |
戻り値
string
翻訳メッセージ
備考
オーバーロードされた $t。詳細については、$t の備考を参照してください。
呼び出しシグネチャ
ts
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
key,
named,
options): string;ロケールメッセージ翻訳
ジェネリック型パラメータ
| ジェネリック型パラメータ | デフォルト型 |
|---|---|
Key extends string | - |
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> | RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> |
Keys | IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
key | number | Key | ResourceKeys | ターゲットロケールメッセージキー |
named | NamedValue | 名前付き補完値 |
options | TranslateOptions | オプション。TranslateOptions を参照してください |
戻り値
string
翻訳メッセージ
備考
オーバーロードされた $t。詳細については、$t の備考を参照してください。
$te()
ts
$te<Key, DefinedLocaleMessage, Keys, ResourceKeys>(key, locale?): boolean;翻訳メッセージの存在確認
ジェネリック型パラメータ
| ジェネリック型パラメータ | デフォルト型 |
|---|---|
Key extends string | - |
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> | RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> |
Keys | IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
key | Key | ResourceKeys | ターゲットロケールメッセージキー |
locale? | string | ロケール、オプション。グローバルスコープまたはローカルスコープのロケールを上書き |
戻り値
boolean
ロケールメッセージが見つかった場合は true、それ以外は false。値がキーにあるが翻訳できない場合でも false が返されることに注意してください。
備考
詳細については、VueI18n#te | `VueI18n#te` または Composer#te | `Composer#te` を参照してください。
$tm()
ts
$tm<Key, DefinedLocaleMessage, Keys, ResourceKeys>(key):
| {
}
| LocaleMessageValue<VueMessageType>;ロケールメッセージ取得
ジェネリック型パラメータ
| ジェネリック型パラメータ | デフォルト型 |
|---|---|
Key extends string | - |
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> | RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> |
Keys | IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never |
ResourceKeys | IsNever<Keys> extends false ? Keys : never |
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
key | Key | ResourceKeys | ターゲットロケールメッセージキー |
戻り値
| { } | LocaleMessageValue<VueMessageType>
ロケールメッセージ
備考
I18nMode | Composition API モードでは、$tm は app.config.globalProperties によって注入されます。 入力/出力は Composer インスタンスと同じであり、グローバルスコープで動作します。詳細については、Composer#tm | `Composer.tm` を参照してください。 現在の locale に基づいて、Composer インスタンスのメッセージからロケールメッセージが返されます。 locale を変更すると、返されるロケールメッセージも対応して変わります。 コンポーザーインスタンスのメッセージに指定された key に対応するロケールメッセージがない場合、フォールバック処理で返されます。
プロパティ
$i18n
ts
$i18n: ExportedGlobalComposer;エクスポートされたグローバルコンポーザーインスタンス
備考
グローバルコンポーザー | createI18n で作成されたコンポーザーインスタンスからエクスポートされたエクスポートされたコンポーザーインスタンスを取得できます。 I18nMode | Composition API モードでエクスポートされたコンポーザーインスタンスを取得できます。 このプロパティで参照されるインスタンスによって管理されるロケール、ロケールメッセージ、その他のリソースはグローバルスコープとして有効です。 i18n コンポーネントカスタムオプションが指定されていない場合、i18n インスタンス I18n.global | グローバルプロパティで参照できる VueI18n インスタンスと同じです。