コンポーネントインジェクション

ComponentCustomOptions

Vue I18nのコンポーネントカスタムプロパティ

シグネチャ:

typescript

export interface ComponentCustomOptions;

i18n

コンポーネント用のVue I18nオプション

シグネチャ:

typescript

i18n?: VueI18nOptions;

関連項目

VueI18nOptions

ComponentCustomProperties

Vue I18nのコンポーネントカスタムオプション

シグネチャ:

typescript

export interface ComponentCustomProperties;

詳細

これらのプロパティはすべての子コンポーネントに注入されます

$i18n

エクスポートされたグローバルコンポーザーインスタンス、またはグローバルVueI18nインスタンス。

シグネチャ:

typescript

$i18n: VueI18n | ExportedGlobalComposer;

詳細

エクスポートされたコンポーザーインスタンスを取得できます。これは、createI18nで作成されたグローバルコンポーザーインスタンスからエクスポートされたもの、またはグローバルVueI18nインスタンスです。

Composition APIモードではエクスポートされたコンポーザーインスタンスを取得し、Legacy APIモードではVuei18nインスタンスを取得します。このプロパティで参照できるインスタンスです。

このプロパティが参照するインスタンスが管理するロケール、ロケールメッセージ、その他のリソースはグローバルスコープとして有効です。

i18nコンポーネントオプションが指定されていない場合、これはi18nインスタンスによるグローバルで参照できるVueI18nインスタンスと同じです。

関連項目

$t(key)

ロケールメッセージの翻訳

シグネチャ:

typescript

$t(key: Key): TranslateResult;

詳細

この機能が反応コンテキストで使用される場合、ロケールが変更されると一度再評価されます。

Composition APIモードでは、$tはapp.config.globalPropertiesによって注入されます。入力/出力はコンポーザーと同じであり、グローバルスコープで動作します。詳細については、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;

注意

Composition APIモードのみv9までは対応しています。v10以降はLegacy APIモードでも利用可能です。

詳細

オーバーロードされた$t。詳細については、$tの備考を参照してください。

パラメータ

パラメータ	タイプ	説明
key	Key	対象のロケールメッセージキー
plural	number	複数形の選択番号
options	TranslateOptions	オプション、TranslateOptionsを参照

戻り値

翻訳メッセージ

$t(key, defaultMsg)

ロケールメッセージの翻訳

シグネチャ:

typescript

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

注意

Composition APIモードのみv9までは対応しています。v10以降はLegacy APIモードでも利用可能です。

詳細

オーバーロードされた$t。詳細については、$tの備考を参照してください。

パラメータ

パラメータ	タイプ	説明
key	Key	対象のロケールメッセージキー
defaultMsg	string	翻訳が見つからない場合に返すデフォルトメッセージ

戻り値

翻訳メッセージ

$t(key, defaultMsg, options)

ロケールメッセージの翻訳

シグネチャ:

typescript

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

注意

Composition APIモードのみv9までは対応しています。v10以降はLegacy APIモードでも利用可能です。

詳細

オーバーロードされた$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;

注意

Composition APIモードのみv9までは対応しています。v10以降はLegacy APIモードでも利用可能です。

詳細

オーバーロードされた$t。詳細については、$tの備考を参照してください。

パラメータ

パラメータ	タイプ	説明
key	Key	対象のロケールメッセージキー
list	unknown[]	リスト補間の値
plural	number	複数形の選択番号

戻り値

翻訳メッセージ

$t(key, list, defaultMsg)

ロケールメッセージの翻訳

シグネチャ:

typescript

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

注意

Composition APIモードのみv9までは対応しています。v10以降はLegacy APIモードでも利用可能です。

詳細

オーバーロードされた$t。詳細については、$tの備考を参照してください。

パラメータ

パラメータ	タイプ	説明
key	Key	対象のロケールメッセージキー
list	unknown[]	リスト補間の値
defaultMsg	string	翻訳が見つからない場合に返すデフォルトメッセージ

戻り値

翻訳メッセージ

$t(key, list, options)

ロケールメッセージの翻訳

シグネチャ:

typescript

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

注意

Composition APIモードのみv9までは対応しています。v10以降はLegacy APIモードでも利用可能です。

詳細

オーバーロードされた$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;

注意

Composition APIモードのみv9までは対応しています。v10以降はLegacy APIモードでも利用可能です。

詳細

オーバーロードされた$t。詳細については、$tの備考を参照してください。

パラメータ

パラメータ	タイプ	説明
key	Key	対象のロケールメッセージキー
named	NamedValue	名前付き補間の値
plural	number	複数形の選択番号

戻り値

翻訳メッセージ

$t(key, named, defaultMsg)

ロケールメッセージの翻訳

シグネチャ:

typescript

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

注意

Composition APIモードのみv9までは対応しています。v10以降はLegacy APIモードでも利用可能です。

詳細

オーバーロードされた$t。詳細については、$tの備考を参照してください。

パラメータ

パラメータ	タイプ	説明
key	Key	対象のロケールメッセージキー
named	NamedValue	名前付き補間の値
defaultMsg	string	翻訳が見つからない場合に返すデフォルトメッセージ

戻り値

翻訳メッセージ

$t(key, named, options)

ロケールメッセージの翻訳

シグネチャ:

typescript

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

注意

Composition APIモードのみv9までは対応しています。v10以降はLegacy APIモードでも利用可能です。

詳細

オーバーロードされた$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#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コンポーネントオプションが指定されていない場合、グローバルスコープのロケールメッセージで取得します。

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

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

コンポーザーインスタンスメッセージに指定されたkeyのロケールメッセージがない場合、フォールバック機構で返されます。

パラメータ

パラメータ	タイプ	説明
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#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#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)

パラメータ

戻り値