レガシー API
Choice
シグネチャ:
export type Choice = number;非推奨
vue-i18n v12 で削除されます
DateTimeFormatResult
シグネチャ:
export type DateTimeFormatResult = string;非推奨
vue-i18n v12 で削除されます
LocaleMessageObject
シグネチャ:
export type LocaleMessageObject<Message = string> = LocaleMessageDictionary<Message>;非推奨
vue-i18n v12 で削除されます
NumberFormatResult
シグネチャ:
export type NumberFormatResult = string;非推奨
vue-i18n v12 で削除されます
PluralizationRulesMap
シグネチャ:
export type PluralizationRulesMap = {
[locale: string]: PluralizationRule;
};非推奨
vue-i18n v12 で削除されます
TranslateResult
シグネチャ:
export type TranslateResult = string;非推奨
vue-i18n v12 で削除されます
VueI18n
VueI18n レガシーインターフェース
シグネチャ:
export interface VueI18n<Messages extends Record<string, any> = {}, DateTimeFormats extends Record<string, any> = {}, NumberFormats extends Record<string, any> = {}, OptionLocale = Locale, ResourceLocales = PickupLocales<NonNullable<Messages>> | PickupLocales<NonNullable<DateTimeFormats>> | PickupLocales<NonNullable<NumberFormats>>, Locales = Locale extends GeneratedLocale ? GeneratedLocale : OptionLocale extends string ? [ResourceLocales] extends [never] ? Locale : ResourceLocales : OptionLocale | ResourceLocales, Composition extends Composer<Messages, DateTimeFormats, NumberFormats, OptionLocale> = Composer<Messages, DateTimeFormats, NumberFormats, OptionLocale>>非推奨
vue-i18n v12 で削除されます
詳細
このインターフェースは VueI18n クラス（Vue I18n v8.x で提供）のインターフェースと互換性があります。
availableLocales
シグネチャ:
readonly availableLocales: Composition['availableLocales'];詳細
メッセージ内の利用可能なロケールのリスト（辞書順）。
d
日時フォーマット
シグネチャ:
d: VueI18nDateTimeFormatting<DateTimeFormats, Locales, RemoveIndexSignature<{
[K in keyof DefineDateTimeFormat]: DefineDateTimeFormat[K];
}>>;詳細
関数の詳細については、VueI18nDateTimeFormatting を参照してください。
datetimeFormats
シグネチャ:
readonly datetimeFormats: {
[K in keyof DateTimeFormats]: DateTimeFormats[K];
};詳細
ローカリゼーションの日時フォーマット。
参照
escapeParameterHtml
シグネチャ:
escapeParameterHtml: Composition['escapeParameter'];詳細
メッセージが翻訳される前に補間パラメータがエスケープされるかどうか。
参照
fallbackLocale
シグネチャ:
fallbackLocale: FallbackLocales<Locales>;詳細
この VueI18n インスタンスが使用している現在のフォールバックロケール。
参照
formatFallbackMessages
シグネチャ:
formatFallbackMessages: Composition['fallbackFormat'];詳細
fallbackLocale またはルートへのフォールバック時に警告を抑制するかどうか。
参照
getDateTimeFormat
日時フォーマットの取得
シグネチャ:
getDateTimeFormat: Composition['getDateTimeFormat'];詳細
VueI18n インスタンス datetimeFormats から日時フォーマットを取得します。
getLocaleMessage
ロケールメッセージの取得
シグネチャ:
getLocaleMessage: Composition['getLocaleMessage'];詳細
VueI18n インスタンス messages からロケールメッセージを取得します。
getNumberFormat
数値フォーマットの取得
シグネチャ:
getNumberFormat: Composition['getNumberFormat'];詳細
VueI18n インスタンス numberFormats から数値フォーマットを取得します。
id
シグネチャ:
id: number;詳細
インスタンス ID。
locale
シグネチャ:
locale: Locales;詳細
この VueI18n インスタンスが使用している現在のロケール。
ロケールに地域と方言が含まれている場合、このロケールには暗黙的なフォールバックが含まれます。
参照
mergeDateTimeFormat
日時フォーマットのマージ
シグネチャ:
mergeDateTimeFormat: Composition['mergeDateTimeFormat'];詳細
日時フォーマットを VueI18n インスタンス datetimeFormats にマージします。
mergeLocaleMessage
ロケールメッセージのマージ
シグネチャ:
mergeLocaleMessage: Composition['mergeLocaleMessage'];詳細
ロケールメッセージを VueI18n インスタンス messages にマージします。
mergeNumberFormat
数値フォーマットのマージ
シグネチャ:
mergeNumberFormat: Composition['mergeNumberFormat'];詳細
数値フォーマットを VueI18n インスタンス numberFormats にマージします。
messages
シグネチャ:
readonly messages: {
[K in keyof Messages]: Messages[K];
};詳細
ローカリゼーションのロケールメッセージ。
参照
missing
シグネチャ:
missing: MissingHandler | null;詳細
ローカリゼーション欠落のハンドラ。
modifiers
シグネチャ:
readonly modifiers: Composition['modifiers'];詳細
リンクされたメッセージのカスタム修飾子。
参照
n
数値フォーマット
シグネチャ:
n: VueI18nNumberFormatting<NumberFormats, Locales, RemoveIndexSignature<{
[K in keyof DefineNumberFormat]: DefineNumberFormat[K];
}>>;詳細
関数の詳細については、VueI18nNumberFormatting を参照してください。
numberFormats
シグネチャ:
readonly numberFormats: {
[K in keyof NumberFormats]: NumberFormats[K];
};詳細
ローカリゼーションの数値フォーマット。
参照
pluralizationRules
単語の複数形化のためのルールセット
シグネチャ:
pluralizationRules: Composition['pluralRules'];参照
postTranslation
シグネチャ:
postTranslation: PostTranslationHandler<VueMessageType> | null;詳細
翻訳の後処理のためのハンドラ。
rt
ロケールメッセージ翻訳の解決
シグネチャ:
rt: VueI18nResolveLocaleMessageTranslation<Locales>;詳細
関数の詳細については、VueI18nResolveLocaleMessageTranslation を参照してください。
setDateTimeFormat
日時フォーマットの設定
シグネチャ:
setDateTimeFormat: Composition['setDateTimeFormat'];詳細
日時フォーマットを VueI18n インスタンス datetimeFormats に設定します。
setLocaleMessage
ロケールメッセージの設定
シグネチャ:
setLocaleMessage: Composition['setLocaleMessage'];詳細
ロケールメッセージを VueI18n インスタンス messages に設定します。
setNumberFormat
数値フォーマットの設定
シグネチャ:
setNumberFormat: Composition['setNumberFormat'];詳細
数値フォーマットを VueI18n インスタンス numberFormats に設定します。
silentFallbackWarn
シグネチャ:
silentFallbackWarn: Composition['fallbackWarn'];詳細
ローカリゼーション失敗時のフォールバック警告を抑制するかどうか。
silentTranslationWarn
シグネチャ:
silentTranslationWarn: Composition['missingWarn'];詳細
ローカリゼーション失敗時に出力される警告を抑制するかどうか。
参照
sync
シグネチャ:
sync: Composition['inheritLocale'];詳細
ルートレベルのロケールをコンポーネントのローカリゼーションロケールに同期するかどうか。
参照
t
ロケールメッセージの翻訳
シグネチャ:
t: VueI18nTranslation<Messages, Locales, RemoveIndexSignature<{
[K in keyof DefineLocaleMessage]: DefineLocaleMessage[K];
}>>;詳細
関数の詳細については、VueI18nTranslation を参照してください。
tm
ロケールメッセージの取得
シグネチャ:
tm: Composition['tm'];詳細
i18n コンポーネントオプション が指定されている場合、グローバルスコープのロケールメッセージよりもローカルスコープのロケールメッセージが優先的に取得されます。
i18n コンポーネントオプション が指定されていない場合、グローバルスコープのロケールメッセージで取得されます。
現在の 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 { createI18n } from 'vue-i18n'
const i18n = createI18n({
messages: {
en: {
contents: [
{
title: 'Title1',
// ...
paragraphs: [
// ...
]
}
]
}
}
// ...
})warnHtmlInMessage
シグネチャ:
warnHtmlInMessage: WarnHtmlInMessageLevel;詳細
HTML フォーマットのロケールメッセージの使用を許可するかどうか。
warn または error を設定した場合、VueI18n インスタンスのロケールメッセージをチェックします。
warn を指定した場合、コンソールに警告が出力されます。
error を指定した場合、エラーが発生します。
参照
te(key, locale)
翻訳ロケールメッセージの存在確認
シグネチャ:
te<Str extends string, Key extends PickupKeys<Messages> = PickupKeys<Messages>>(key: Str | Key, locale?: Locales): boolean;詳細
VueI18n インスタンス messages にロケールメッセージが存在するかどうか。
locale を指定した場合、その locale のロケールメッセージをチェックします。
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| key | Str | Key | ターゲットとなるロケールメッセージのキー |
| locale | Locales | ターゲットとなるロケール |
戻り値
ロケールメッセージが見つかった場合は true、それ以外は false
VueI18nDateTimeFormatting
VueI18n レガシーインターフェースの日時フォーマット関数
シグネチャ:
export interface VueI18nDateTimeFormatting<DateTimeFormats extends Record<string, any> = {}, Locales = 'en-US', DefinedDateTimeFormat extends RemovedIndexResources<DefineDateTimeFormat> = RemovedIndexResources<DefineDateTimeFormat>, C = IsEmptyObject<DefinedDateTimeFormat> extends false ? PickupFormatPathKeys<{
[K in keyof DefinedDateTimeFormat]: DefinedDateTimeFormat[K];
}> : never, M = IsEmptyObject<DateTimeFormats> extends false ? PickupFormatKeys<DateTimeFormats> : never, ResourceKeys extends C | M = IsNever<C> extends false ? IsNever<M> extends false ? C | M : C : IsNever<M> extends false ? M : never>非推奨
vue-i18n v12 で削除されます
詳細
これは VueI18n のためのインターフェースです。
(value: number | Date): DateTimeFormatResult;
日時フォーマット
シグネチャ:
(value: number | Date): DateTimeFormatResult;詳細
リアクティブなコンテキストで使用される場合、ロケールが変更されると再評価されます。
i18n コンポーネントオプション が指定されている場合、グローバルスコープの日時フォーマットよりもローカルスコープの日時フォーマットが優先的にフォーマットされます。
i18n コンポーネントオプション が指定されていない場合、グローバルスコープの日時フォーマットでフォーマットされます。
参照
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| value | number | Date | 値。タイムスタンプの数値または Date インスタンス |
戻り値
フォーマットされた値
(value: Value, key: Key | ResourceKeys): DateTimeFormatResult;
日時フォーマット
シグネチャ:
<Value extends number | Date = number, Key extends string = string>(value: Value, key: Key | ResourceKeys): DateTimeFormatResult;詳細
オーバーロードされた d。詳細については、コールシグネチャ の詳細を参照してください。
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| value | Value | 値。タイムスタンプの数値または Date インスタンス |
| key | Key | ResourceKeys | 日時フォーマットのキー |
戻り値
フォーマットされた値
(value: Value, key: Key | ResourceKeys, locale: Locales): DateTimeFormatResult;
日時フォーマット
シグネチャ:
<Value extends number | Date = number, Key extends string = string>(value: Value, key: Key | ResourceKeys, locale: Locales): DateTimeFormatResult;詳細
オーバーロードされた d。詳細については、コールシグネチャ の詳細を参照してください。
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| value | Value | 値。タイムスタンプの数値または Date インスタンス |
| key | Key | ResourceKeys | 日時フォーマットのキー |
| locale | Locales | ロケール。グローバルスコープまたはローカルスコープよりも優先されます。 |
戻り値
フォーマットされた値
(value: number | Date, args: { [key: string]: string | boolean | number; }): DateTimeFormatResult;
日時フォーマット
シグネチャ:
(value: number | Date, args: {
[key: string]: string | boolean | number;
}): DateTimeFormatResult;詳細
オーバーロードされた d。詳細については、コールシグネチャ の詳細を参照してください。
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| value | number | Date | 値。タイムスタンプの数値または Date インスタンス |
| args | { [key: string]: string | boolean | number; } | 引数の値 |
戻り値
フォーマットされた値
VueI18nNumberFormatting
VueI18n レガシーインターフェースの数値フォーマット関数
シグネチャ:
export interface VueI18nNumberFormatting<NumberFormats extends Record<string, any> = {}, Locales = 'en-US', DefinedNumberFormat extends RemovedIndexResources<DefineNumberFormat> = RemovedIndexResources<DefineNumberFormat>, C = IsEmptyObject<DefinedNumberFormat> extends false ? PickupFormatPathKeys<{
[K in keyof DefinedNumberFormat]: DefinedNumberFormat[K];
}> : never, M = IsEmptyObject<NumberFormats> extends false ? PickupFormatKeys<NumberFormats> : never, ResourceKeys extends C | M = IsNever<C> extends false ? IsNever<M> extends false ? C | M : C : IsNever<M> extends false ? M : never>非推奨
vue-i18n v12 で削除されます
詳細
これは VueI18n のためのインターフェースです。
(value: number): NumberFormatResult;
数値フォーマット
シグネチャ:
(value: number): NumberFormatResult;詳細
リアクティブなコンテキストで使用される場合、ロケールが変更されると再評価されます。
i18n コンポーネントオプション が指定されている場合、グローバルスコープの数値フォーマットよりもローカルスコープの数値フォーマットが優先的にフォーマットされます。
i18n コンポーネントオプション が指定されていない場合、グローバルスコープの数値フォーマットでフォーマットされます。
参照
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| value | number | 数値 |
戻り値
フォーマットされた値
(value: number, key: Key | ResourceKeys): NumberFormatResult;
数値フォーマット
シグネチャ:
<Key extends string = string>(value: number, key: Key | ResourceKeys): NumberFormatResult;詳細
オーバーロードされた n。詳細については、コールシグネチャ の詳細を参照してください。
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| value | number | 数値 |
| key | Key | ResourceKeys | 数値フォーマットのキー |
戻り値
フォーマットされた値
(value: number, key: Key | ResourceKeys, locale: Locales): NumberFormatResult;
数値フォーマット
シグネチャ:
<Key extends string = string>(value: number, key: Key | ResourceKeys, locale: Locales): NumberFormatResult;詳細
オーバーロードされた n。詳細については、コールシグネチャ の詳細を参照してください。
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| value | number | 数値 |
| key | Key | ResourceKeys | 数値フォーマットのキー |
| locale | Locales | ロケール。グローバルスコープまたはローカルスコープよりも優先されます。 |
戻り値
フォーマットされた値
(value: number, args: { [key: string]: string | boolean | number; }): NumberFormatResult;
数値フォーマット
シグネチャ:
(value: number, args: {
[key: string]: string | boolean | number;
}): NumberFormatResult;詳細
オーバーロードされた n。詳細については、コールシグネチャ の詳細を参照してください。
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| value | number | 数値 |
| args | { [key: string]: string | boolean | number; } | 引数の値 |
戻り値
フォーマットされた値
VueI18nOptions
VueI18n オプション
シグネチャ:
export interface VueI18nOptions<Schema extends {
message?: unknown;
datetime?: unknown;
number?: unknown;
} = {
message: DefaultLocaleMessageSchema;
datetime: DefaultDateTimeFormatSchema;
number: DefaultNumberFormatSchema;
}, Locales extends {
messages: unknown;
datetimeFormats: unknown;
numberFormats: unknown;
} | string = Locale, Options extends ComposerOptions<Schema, Locales> = ComposerOptions<Schema, Locales>>非推奨
vue-i18n v12 で削除されます
詳細
このオプションは VueI18n クラスコンストラクタオプション（Vue I18n v8.x で提供）と互換性があります。
availableLocales
シグネチャ:
availableLocales?: Locale[];詳細
メッセージ内の利用可能なロケールのリスト（辞書順）。
デフォルト値
[]
datetime
datetimeFormats
escapeParameterHtml
シグネチャ:
escapeParameterHtml?: Options['escapeParameter'];詳細
リストまたは名前付き補間値のパラメータをエスケープするかどうか。有効にすると、このオプションは以下を行います：
- 補間パラメータ内の HTML 特殊文字（
<、>、"、'、&、/、=）をエスケープします。 - 以下の方法で XSS 攻撃を防ぐために、最終的な翻訳済み HTML をサニタイズします：
- HTML 属性値内の危険な文字をエスケープする
- イベントハンドラ属性（onclick、onerror など）を無効にする
- href、src、action、formaction、および style 属性内の javascript: URL を無効にする
これは、翻訳出力が v-html で使用され、翻訳リソースに HTML マークアップ（例：ユーザー提供値の周りの <span>）が含まれている場合に便利です。
この使用パターンは、主に事前に計算されたテキスト文字列を UI コンポーネントに渡す場合に発生します。
エスケーププロセスでは、次の記号がそれぞれの HTML 文字エンティティに置き換えられます：<、>、"、'。
escapeParameterHtml を true に設定しても既存の機能が壊れることはありませんが、微妙なタイプの XSS 攻撃ベクトルに対する保護を提供します。
デフォルト値
false
参照
fallbackLocale
シグネチャ:
fallbackLocale?: Options['fallbackLocale'];詳細
フォールバックローカリゼーションのロケール。
より複雑なフォールバック定義については、フォールバックを参照してください。
デフォルト値
指定されていない場合はデフォルトの 'en-US'、または locale 値
参照
fallbackRoot
シグネチャ:
fallbackRoot?: Options['fallbackRoot'];詳細
コンポーネントローカリゼーションにおいて、ローカリゼーションが失敗した場合にルートレベル（グローバルスコープ）のローカリゼーションにフォールバックするかどうか。
false の場合、ルートにフォールバックしません。
デフォルト値
true
参照
flatJson
シグネチャ:
flatJson?: Options['flatJson'];詳細
フラットな json メッセージの使用を許可するかどうか。
デフォルト値
false
formatFallbackMessages
シグネチャ:
formatFallbackMessages?: Options['fallbackFormat'];詳細
fallbackLocale またはルートへのフォールバック時に警告を抑制するかどうか。
デフォルト値
false
参照
locale
シグネチャ:
locale?: Options['locale'];詳細
ローカリゼーションのロケール。
ロケールに地域と方言が含まれている場合、このロケールには暗黙的なフォールバックが含まれます。
デフォルト値
'en-US'
参照
message
messageResolver
シグネチャ:
messageResolver?: MessageResolver;詳細
messages を解決するためのメッセージリゾルバ。
指定されていない場合、vue-i18n 内部メッセージリゾルバがデフォルトで使用されます。
次の要件をサポートするメッセージリゾルバを自分で実装する必要があります：
メッセージリゾルバの最初の引数として渡された
localeのロケールメッセージと、2 番目の引数として渡されたパスを使用してメッセージを解決します。メッセージが解決できなかった場合は、
nullを返す必要があります。nullを返した場合、fallbackLocaleが有効であればフォールバック時にもメッセージリゾルバが呼び出されるため、メッセージも解決する必要があります。
メッセージリゾルバは、次の API によって間接的に呼び出されます：
TIP
🆕 v9.2+
WARNING
メッセージリゾルバを使用する場合、flatJson 設定は無視されます。つまり、フラット JSON を自分で解決する必要があります。
デフォルト値
undefined
参照
例
createI18n を使用して設定する方法の例を次に示します：
import { createI18n } from 'vue-i18n'
// あなたのメッセージリゾルバ
function messageResolver(obj, path) {
// シンプルなメッセージ解決！
const msg = obj[path]
return msg != null ? msg : null
}
// I18n オプションで呼び出す
const i18n = createI18n({
locale: 'ja',
messageResolver, // あなたのメッセージリゾルバを設定
messages: {
en: { ... },
ja: { ... }
}
})
// 以下、あなたの処理 ...
// ...messages
missing
シグネチャ:
missing?: Options['missing'];詳細
ローカリゼーション欠落のハンドラ。
ハンドラは、ローカリゼーションターゲットロケール、ローカリゼーションパスキー、Vue インスタンス、および値とともに呼び出されます。
欠落ハンドラが割り当てられ、ローカリゼーションの欠落が発生した場合、警告は表示されません。
デフォルト値
null
modifiers
シグネチャ:
modifiers?: Options['modifiers'];詳細
リンクされたメッセージのカスタム修飾子。
参照
number
numberFormats
pluralizationRules
シグネチャ:
pluralizationRules?: Options['pluralRules'];詳細
単語の複数形化のためのルールセット
デフォルト値
{}
参照
postTranslation
シグネチャ:
postTranslation?: Options['postTranslation'];詳細
翻訳の後処理のためのハンドラ。ハンドラは $t および t で呼び出された後に取得されます。
このハンドラは、スペースのトリミングなど、翻訳されたテキストをフィルタリングする場合に便利です。
デフォルト値
null
sharedMessages
シグネチャ:
sharedMessages?: LocaleMessages<VueMessageType>;詳細
コンポーネントのローカリゼーションのための共有ロケールメッセージ。詳細については、コンポーネントベースのローカリゼーションを参照してください。
デフォルト値
undefined
参照
silentFallbackWarn
シグネチャ:
silentFallbackWarn?: Options['fallbackWarn'];詳細
言語にキーの翻訳がない場合に、翻訳キーに対してテンプレート補間を行うかどうか。
true の場合、「ベース」言語のテンプレートの書き込みをスキップします。キーがテンプレートになります。
デフォルト値
false
参照
silentTranslationWarn
シグネチャ:
silentTranslationWarn?: Options['missingWarn'];詳細
ローカリゼーション失敗時に出力される警告を抑制するかどうか。
true の場合、ローカリゼーション失敗の警告を抑制します。
正規表現を使用する場合、翻訳キー（例：t）と一致するローカリゼーション失敗の警告を抑制できます。
デフォルト値
false
参照
sync
シグネチャ:
sync?: boolean;詳細
ルートレベルのロケールをコンポーネントのローカリゼーションロケールに同期するかどうか。
false の場合、ルートレベルのロケールに関係なく、各コンポーネントロケールに対してローカライズします。
デフォルト値
true
参照
warnHtmlInMessage
シグネチャ:
warnHtmlInMessage?: WarnHtmlInMessageLevel;詳細
HTML フォーマットのロケールメッセージの使用を許可するかどうか。
warnHtmlInMessage プロパティを参照してください。
デフォルト値
'off'
参照
VueI18nResolveLocaleMessageTranslation
VueI18n レガシーインターフェースのロケールメッセージ翻訳解決関数
シグネチャ:
export type VueI18nResolveLocaleMessageTranslation<Locales = 'en-US'> = ComposerResolveLocaleMessageTranslation<Locales>;非推奨
vue-i18n v12 で削除されます
詳細
これは VueI18n のためのインターフェースです。このインターフェースは ComposerResolveLocaleMessageTranslation のエイリアスです。
VueI18nTranslation
VueI18n レガシーインターフェースのロケールメッセージ翻訳関数
シグネチャ:
export interface VueI18nTranslation<Messages extends Record<string, any> = {}, Locales = 'en-US', DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> = RemovedIndexResources<DefineLocaleMessage>, C = IsEmptyObject<DefinedLocaleMessage> extends false ? PickupPaths<{
[K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K];
}> : never, M = IsEmptyObject<Messages> extends false ? PickupKeys<Messages> : never, ResourceKeys extends C | M = IsNever<C> extends false ? IsNever<M> extends false ? C | M : C : IsNever<M> extends false ? M : never>非推奨
vue-i18n v12 で削除されます
詳細
これは VueI18n のためのインターフェースです。
(key: Key | ResourceKeys): TranslateResult;
ロケールメッセージの翻訳。
シグネチャ:
<Key extends string>(key: Key | ResourceKeys): TranslateResult;詳細
リアクティブなコンテキストで使用される場合、ロケールが変更されると再評価されます。
i18n コンポーネントオプション が指定されている場合、グローバルスコープのロケールメッセージよりもローカルスコープのロケールメッセージが優先的に翻訳されます。
i18n コンポーネントオプション が指定されていない場合、グローバルスコープのロケールメッセージで翻訳されます。
参照
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| key | Key | ResourceKeys | ターゲットとなるロケールメッセージのキー |
戻り値
翻訳メッセージ
(key: Key | ResourceKeys, named: Record<string, unknown>): TranslateResult;
ロケールメッセージの翻訳。
シグネチャ:
<Key extends string>(key: Key | ResourceKeys, named: Record<string, unknown>): TranslateResult;詳細
オーバーロードされた t。詳細については、コールシグネチャ の詳細を参照してください。
参照
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| key | Key | ResourceKeys | ターゲットとなるロケールメッセージのキー |
| named | Record<string, unknown> | 名前付き補間の値 |
戻り値
翻訳メッセージ
(key: Key | ResourceKeys, named: NamedValue, plural: number): TranslateResult;
名前付き補間と複数形のためのロケールメッセージ翻訳
シグネチャ:
<Key extends string>(key: Key | ResourceKeys, named: NamedValue, plural: number): TranslateResult;詳細
オーバーロードされた t。詳細については、コールシグネチャ の詳細を参照してください。
このオーバーロードされた t では、各プレースホルダー x に対して、ロケールメッセージに {x} トークンが含まれている必要があり、複数形化された翻訳メッセージを返します。
参照
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| key | Key | ResourceKeys | ターゲットとなるロケールメッセージのキー |
| named | NamedValue | 名前付き補間の値 |
| plural | number | 取得する複数形の文字列。1 は最初のものを返します。 |
戻り値
翻訳メッセージ
(key: Key | ResourceKeys, named: NamedValue, defaultMsg: string): TranslateResult;
名前付き補間と複数形のためのロケールメッセージ翻訳
シグネチャ:
<Key extends string>(key: Key | ResourceKeys, named: NamedValue, defaultMsg: string): TranslateResult;詳細
オーバーロードされた t。詳細については、コールシグネチャ の詳細を参照してください。
このオーバーロードされた t では、各プレースホルダー x に対して、ロケールメッセージに {x} トークンが含まれている必要があり、翻訳が見つからなかった場合はデフォルトメッセージを返します。
参照
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| key | Key | ResourceKeys | ターゲットとなるロケールメッセージのキー |
| named | NamedValue | 名前付き補間の値 |
| defaultMsg | string | 翻訳が見つからなかった場合に返すデフォルトメッセージ |
戻り値
翻訳メッセージ
(key: Key | ResourceKeys, named: NamedValue, options: TranslateOptions<Locales>): TranslateResult;
名前付き補間のためのロケールメッセージ翻訳
シグネチャ:
<Key extends string>(key: Key | ResourceKeys, named: NamedValue, options: TranslateOptions<Locales>): TranslateResult;詳細
オーバーロードされた t。詳細については、コールシグネチャ の詳細を参照してください。
このオーバーロードされた t では、各プレースホルダー x に対して、ロケールメッセージに {x} トークンが含まれている必要があります。
オプションに従って、翻訳が欠落している場合の警告を抑制することもできます。
オプションの詳細については、 を参照してください。
参照
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| key | Key | ResourceKeys | ターゲットとなるロケールメッセージのキー |
| named | NamedValue | 名前付き補間の値 |
| options | TranslateOptions<Locales> | 翻訳のための追加 |
戻り値
翻訳メッセージ
(key: Key | ResourceKeys, plural: number): TranslateResult;
複数形のためのロケールメッセージ翻訳
シグネチャ:
<Key extends string>(key: Key | ResourceKeys, plural: number): TranslateResult;詳細
オーバーロードされた t。詳細については、コールシグネチャ の詳細を参照してください。
このオーバーロードされた t では、複数形化された翻訳メッセージを返します。
オプションに従って、翻訳が欠落している場合の警告を抑制することもできます。
参照
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| key | Key | ResourceKeys | ターゲットとなるロケールメッセージのキー |
| plural | number | 取得する複数形の文字列。1 は最初のものを返します。 |
戻り値
翻訳メッセージ
(key: Key | ResourceKeys, plural: number, options: TranslateOptions<Locales>): TranslateResult;
複数形のためのロケールメッセージ翻訳
シグネチャ:
<Key extends string>(key: Key | ResourceKeys, plural: number, options: TranslateOptions<Locales>): TranslateResult;詳細
オーバーロードされた t。詳細については、コールシグネチャ の詳細を参照してください。
このオーバーロードされた t では、複数形化された翻訳メッセージを返します。
オプションに従って、翻訳が欠落している場合の警告を抑制することもできます。
オプションの詳細については、 を参照してください。
参照
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| key | Key | ResourceKeys | ターゲットとなるロケールメッセージのキー |
| plural | number | 取得する複数形の文字列。1 は最初のものを返します。 |
| options | TranslateOptions<Locales> | 翻訳のための追加 |
戻り値
翻訳メッセージ
(key: Key | ResourceKeys, defaultMsg: string): TranslateResult;
欠落しているデフォルトメッセージのためのロケールメッセージ翻訳
シグネチャ:
<Key extends string>(key: Key | ResourceKeys, defaultMsg: string): TranslateResult;詳細
オーバーロードされた t。詳細については、コールシグネチャ の詳細を参照してください。
このオーバーロードされた t では、翻訳が見つからなかった場合、デフォルトメッセージを返します。
オプションに従って、翻訳が欠落している場合の警告を抑制することもできます。
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| key | Key | ResourceKeys | ターゲットとなるロケールメッセージのキー |
| defaultMsg | string | 翻訳が見つからなかった場合に返すデフォルトメッセージ |
戻り値
翻訳メッセージ
(key: Key | ResourceKeys, defaultMsg: string, options: TranslateOptions<Locales>): TranslateResult;
欠落しているデフォルトメッセージのためのロケールメッセージ翻訳
シグネチャ:
<Key extends string>(key: Key | ResourceKeys, defaultMsg: string, options: TranslateOptions<Locales>): TranslateResult;詳細
オーバーロードされた t。詳細については、コールシグネチャ の詳細を参照してください。
このオーバーロードされた t では、翻訳が見つからなかった場合、デフォルトメッセージを返します。
オプションに従って、翻訳が欠落している場合の警告を抑制することもできます。
オプションの詳細については、 を参照してください。
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| key | Key | ResourceKeys | ターゲットとなるロケールメッセージのキー |
| defaultMsg | string | 翻訳が見つからなかった場合に返すデフォルトメッセージ |
| options | TranslateOptions<Locales> | 翻訳のための追加 |
戻り値
翻訳メッセージ
(key: Key | ResourceKeys, list: unknown[]): TranslateResult;
ロケールメッセージの翻訳。
シグネチャ:
<Key extends string>(key: Key | ResourceKeys, list: unknown[]): TranslateResult;詳細
オーバーロードされた t。詳細については、コールシグネチャ の詳細を参照してください。
参照
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| key | Key | ResourceKeys | ターゲットとなるロケールメッセージのキー |
| list | unknown[] | リスト補間の値 |
戻り値
翻訳メッセージ
(key: Key | ResourceKeys, list: unknown[], plural: number): TranslateResult;
リスト補間と複数形のためのロケールメッセージ翻訳
シグネチャ:
<Key extends string>(key: Key | ResourceKeys, list: unknown[], plural: number): TranslateResult;詳細
オーバーロードされた t。詳細については、コールシグネチャ の詳細を参照してください。
このオーバーロードされた t では、ロケールメッセージはリスト内の各プレースホルダーに対して {0}、{1}、… を含む必要があり、複数形化された翻訳メッセージを返します。
参照
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| key | Key | ResourceKeys | ターゲットとなるロケールメッセージのキー |
| list | unknown[] | リスト補間の値 |
| plural | number | 取得する複数形の文字列。1 は最初のものを返します。 |
戻り値
翻訳メッセージ
(key: Key | ResourceKeys, list: unknown[], defaultMsg: string): TranslateResult;
リスト補間と欠落しているデフォルトメッセージのためのロケールメッセージ翻訳
シグネチャ:
<Key extends string>(key: Key | ResourceKeys, list: unknown[], defaultMsg: string): TranslateResult;詳細
オーバーロードされた t。詳細については、コールシグネチャ の詳細を参照してください。
このオーバーロードされた t では、ロケールメッセージはリスト内の各プレースホルダーに対して {0}、{1}、… を含む必要があり、翻訳が見つからなかった場合はデフォルトメッセージを返します。
参照
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| key | Key | ResourceKeys | ターゲットとなるロケールメッセージのキー |
| list | unknown[] | リスト補間の値 |
| defaultMsg | string | 翻訳が見つからなかった場合に返すデフォルトメッセージ |
戻り値
翻訳メッセージ
(key: Key | ResourceKeys, list: unknown[], options: TranslateOptions<Locales>): TranslateResult;
リスト補間のためのロケールメッセージ翻訳
シグネチャ:
<Key extends string>(key: Key | ResourceKeys, list: unknown[], options: TranslateOptions<Locales>): TranslateResult;詳細
オーバーロードされた t。詳細については、コールシグネチャ の詳細を参照してください。
このオーバーロードされた t では、ロケールメッセージはリスト内の各プレースホルダーに対して {0}、{1}、… を含む必要があります。
オプションに従って、翻訳が欠落している場合の警告を抑制することもできます。
オプションの詳細については、 を参照してください。
参照
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| key | Key | ResourceKeys | ターゲットとなるロケールメッセージのキー |
| list | unknown[] | リスト補間の値 |
| options | TranslateOptions<Locales> | 翻訳のための追加 |
戻り値
翻訳メッセージ
WarnHtmlInMessageLevel
シグネチャ:
export type WarnHtmlInMessageLevel = 'off' | 'warn' | 'error';非推奨
vue-i18n v12 で削除されます