Skip to content

レガシーアンプ

Choice

署名:

typescript
export type Choice = number;

非推奨

vue-i18n v12で削除されます

DateTimeFormatResult

署名:

typescript
export type DateTimeFormatResult = string;

非推奨

vue-i18n v12で削除されます

LocaleMessageObject

署名:

typescript
export type LocaleMessageObject<Message = string> = LocaleMessageDictionary<Message>;

非推奨

vue-i18n v12で削除されます

NumberFormatResult

署名:

typescript
export type NumberFormatResult = string;

非推奨

vue-i18n v12で削除されます

PluralizationRulesMap

署名:

typescript
export type PluralizationRulesMap = {
    [locale: string]: PluralizationRule;
};

非推奨

vue-i18n v12で削除されます

TranslateResult

署名:

typescript
export type TranslateResult = string;

非推奨

vue-i18n v12で削除されます

VueI18n

VueI18n レガシーインターフェース

署名:

typescript
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で削除されます

詳細

このインターフェースは、Vue I18n v8.xで提供されるVueI18nクラスのインターフェースと互換性があります。

availableLocales

署名:

typescript
readonly availableLocales: Composition['availableLocales'];

詳細

messagesにおける利用可能なロケールのリスト。語彙順です。

d

日時形式

署名:

typescript
d: VueI18nDateTimeFormatting<DateTimeFormats, Locales, RemoveIndexSignature<{
        [K in keyof DefineDateTimeFormat]: DefineDateTimeFormat[K];
    }>>;

詳細

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

datetimeFormats

署名:

typescript
readonly datetimeFormats: {
        [K in keyof DateTimeFormats]: DateTimeFormats[K];
    };

詳細

ローカライズの日時形式です。

関連項目

escapeParameterHtml

署名:

typescript
escapeParameterHtml: Composition['escapeParameter'];

詳細

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

関連項目

fallbackLocale

署名:

typescript
fallbackLocale: FallbackLocales<Locales>;

詳細

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

関連項目

formatFallbackMessages

署名:

typescript
formatFallbackMessages: Composition['fallbackFormat'];

詳細

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

関連項目

getDateTimeFormat

日時形式の取得

署名:

typescript
getDateTimeFormat: Composition['getDateTimeFormat'];

詳細

VueI18nインスタンスのdatetimeFormatsから日時形式を取得します。

getLocaleMessage

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

署名:

typescript
getLocaleMessage: Composition['getLocaleMessage'];

詳細

VueI18nインスタンスのメッセージからロケールメッセージを取得します。

getNumberFormat

数値形式の取得

署名:

typescript
getNumberFormat: Composition['getNumberFormat'];

詳細

VueI18nインスタンスのnumberFormatsから数値形式を取得します。

id

署名:

typescript
id: number;

詳細

インスタンスID。

locale

署名:

typescript
locale: Locales;

詳細

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

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

関連項目

mergeDateTimeFormat

日時形式のマージ

署名:

typescript
mergeDateTimeFormat: Composition['mergeDateTimeFormat'];

詳細

VueI18nインスタンスのdatetimeFormatsに日時形式をマージします。

mergeLocaleMessage

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

署名:

typescript
mergeLocaleMessage: Composition['mergeLocaleMessage'];

詳細

VueI18nインスタンスのメッセージにロケールメッセージをマージします。

mergeNumberFormat

数値形式のマージ

署名:

typescript
mergeNumberFormat: Composition['mergeNumberFormat'];

詳細

VueI18nインスタンスのnumberFormatsに数値形式をマージします。

messages

署名:

typescript
readonly messages: {
        [K in keyof Messages]: Messages[K];
    };

詳細

ローカライズのロケールメッセージです。

関連項目

missing

署名:

typescript
missing: MissingHandler | null;

詳細

ローカライズ不足のハンドラです。

modifiers

署名:

typescript
readonly modifiers: Composition['modifiers'];

詳細

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

関連項目

n

数値形式

署名:

typescript
n: VueI18nNumberFormatting<NumberFormats, Locales, RemoveIndexSignature<{
        [K in keyof DefineNumberFormat]: DefineNumberFormat[K];
    }>>;

詳細

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

numberFormats

署名:

typescript
readonly numberFormats: {
        [K in keyof NumberFormats]: NumberFormats[K];
    };

詳細

ローカライズの数値形式です。

関連項目

pluralizationRules

単語の複数形規則のセット

署名:

typescript
pluralizationRules: Composition['pluralRules'];

関連項目

postTranslation

署名:

typescript
postTranslation: PostTranslationHandler<VueMessageType> | null;

詳細

翻訳後の処理のハンドラです。

rt

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

署名:

typescript
rt: VueI18nResolveLocaleMessageTranslation<Locales>;

詳細

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

setDateTimeFormat

日時形式の設定

署名:

typescript
setDateTimeFormat: Composition['setDateTimeFormat'];

詳細

VueI18nインスタンスのdatetimeFormatsに日時形式を設定します。

setLocaleMessage

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

署名:

typescript
setLocaleMessage: Composition['setLocaleMessage'];

詳細

VueI18nインスタンスのメッセージにロケールメッセージを設定します。

setNumberFormat

数値形式の設定

署名:

typescript
setNumberFormat: Composition['setNumberFormat'];

詳細

VueI18nインスタンスのnumberFormatsに数値形式を設定します。

silentFallbackWarn

署名:

typescript
silentFallbackWarn: Composition['fallbackWarn'];

詳細

ローカライズに失敗したときにフォールバック警告を抑制するかどうかです。

silentTranslationWarn

署名:

typescript
silentTranslationWarn: Composition['missingWarn'];

詳細

ローカライズに失敗したときに警告を抑制するかどうかです。

関連項目

sync

署名:

typescript
sync: Composition['inheritLocale'];

詳細

ルートレベルのロケールをコンポーネントローカライズロケールに同期するかどうかです。

関連項目

t

ロケールメッセージ翻訳

署名:

typescript
t: VueI18nTranslation<Messages, Locales, RemoveIndexSignature<{
        [K in keyof DefineLocaleMessage]: DefineLocaleMessage[K];
    }>>;

詳細

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

tm

ロケールメッセージ取得

署名:

typescript
tm: Composition['tm'];

詳細

i18nコンポーネントオプションが指定されている場合、グローバルスコープのロケールメッセージよりもローカルスコープのロケールメッセージを優先的に取得します。

i18nコンポーネントオプションが指定されていない場合、グローバルスコープのロケールメッセージで取得します。

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

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

コンポーザーインスタンスメッセージに指定されたkeyに対するロケールメッセージがない場合、フォールバックを使って返されます。

WARNING

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

テンプレート:

html
<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>
js
import { createI18n } from 'vue-i18n'

const i18n = createI18n({
  messages: {
    en: {
      contents: [
        {
          title: 'Title1',
          // ...
          paragraphs: [
            // ...
          ]
        }
      ]
    }
  }
  // ...
})

warnHtmlInMessage

署名:

typescript
warnHtmlInMessage: WarnHtmlInMessageLevel;

詳細

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

warnまたはerrorを設定した場合、VueI18nインスタンスのロケールメッセージを確認します。

warnを指定した場合は、コンソールに警告が出力されます。

errorを指定した場合はエラーが発生します。

関連項目

te(key, locale)

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

署名:

typescript
te<Str extends string, Key extends PickupKeys<Messages> = PickupKeys<Messages>>(key: Str | Key, locale?: Locales): boolean;

詳細

VueI18nインスタンスのメッセージにロケールメッセージが存在するかどうかです。

localeを指定した場合、そのlocaleのロケールメッセージを確認します。

パラメータ

パラメータタイプ説明
keyStr | Key対象のロケールメッセージキー
localeLocales対象のロケール

戻り値

ロケールメッセージが見つかった場合はtrue、それ以外はfalse

VueI18nDateTimeFormatting

VueI18nレガシーインターフェースの日時形式関数

署名:

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

日時形式

署名:

typescript
(value: number | Date): DateTimeFormatResult;

詳細

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

i18nコンポーネントオプションが指定されている場合、グローバルスコープのロケールメッセージよりもローカルスコープの日時形式を優先的にフォーマットします。

i18nコンポーネントオプションが指定されていない場合、グローバルスコープの日時形式でフォーマットします。

関連項目

パラメータ

パラメータタイプ説明
valuenumber | Date値、タイムスタンプ数またはDateインスタンス

戻り値

フォーマットされた値

(value: Value, key: Key | ResourceKeys): DateTimeFormatResult;

日時形式

署名:

typescript
<Value extends number | Date = number, Key extends string = string>(value: Value, key: Key | ResourceKeys): DateTimeFormatResult;

詳細

オーバーロードされたd。詳細は呼び出しシグネチャの詳細を参照してください。

パラメータ

パラメータタイプ説明
valueValue値、タイムスタンプ数またはDateインスタンス
keyKey | ResourceKeys日時形式のキー

戻り値

フォーマットされた値

(value: Value, key: Key | ResourceKeys, locale: Locales): DateTimeFormatResult;

日時形式

署名:

typescript
<Value extends number | Date = number, Key extends string = string>(value: Value, key: Key | ResourceKeys, locale: Locales): DateTimeFormatResult;

詳細

オーバーロードされたd。詳細は呼び出しシグネチャの詳細を参照してください。

パラメータ

パラメータタイプ説明
valueValue値、タイムスタンプ数またはDateインスタンス
keyKey | ResourceKeys日時形式のキー
localeLocalesロケール、グローバルスコープまたはローカルスコープより優先して使用されます。

戻り値

フォーマットされた値

(value: number | Date, args: { [key: string]: string | boolean | number; }): DateTimeFormatResult;

日時形式

署名:

typescript
(value: number | Date, args: {
        [key: string]: string | boolean | number;
    }): DateTimeFormatResult;

詳細

オーバーロードされたd。詳細は呼び出しシグネチャの詳細を参照してください。

パラメータ

パラメータタイプ説明
valuenumber | Date値、タイムスタンプ数またはDateインスタンス
args{ [key: string]: string | boolean | number; }引数値

戻り値

フォーマットされた値

VueI18nNumberFormatting

VueI18nレガシーインターフェースの数値形式関数

署名:

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

数値形式

署名:

typescript
(value: number): NumberFormatResult;

詳細

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

i18nコンポーネントオプションが指定されている場合、グローバルスコープのロケールメッセージよりもローカルスコープの数値形式を優先的にフォーマットします。

i18nコンポーネントオプションが指定されていない場合、グローバルスコープの数値形式でフォーマットします。

関連項目

パラメータ

パラメータタイプ説明
valuenumber数値

戻り値

フォーマットされた値

(value: number, key: Key | ResourceKeys): NumberFormatResult;

数値形式

署名:

typescript
<Key extends string = string>(value: number, key: Key | ResourceKeys): NumberFormatResult;

詳細

オーバーロードされたn。詳細は呼び出しシグネチャの詳細を参照してください。

パラメータ

パラメータタイプ説明
valuenumber数値
keyKey | ResourceKeys数値形式のキー

戻り値

フォーマットされた値

(value: number, key: Key | ResourceKeys, locale: Locales): NumberFormatResult;

数値形式

署名:

typescript
<Key extends string = string>(value: number, key: Key | ResourceKeys, locale: Locales): NumberFormatResult;

詳細

オーバーロードされたn。詳細は呼び出しシグネチャの詳細を参照してください。

パラメータ

パラメータタイプ説明
valuenumber数値
keyKey | ResourceKeys数値形式のキー
localeLocalesロケール、グローバルスコープまたはローカルスコープより優先して使用されます。

戻り値

フォーマットされた値

(value: number, args: { [key: string]: string | boolean | number; }): NumberFormatResult;

数値形式

署名:

typescript
(value: number, args: {
        [key: string]: string | boolean | number;
    }): NumberFormatResult;

詳細

オーバーロードされたn。詳細は呼び出しシグネチャの詳細を参照してください。

パラメータ

パラメータタイプ説明
valuenumber数値
args{ [key: string]: string | boolean | number; }引数値

戻り値

フォーマットされた値

VueI18nOptions

VueI18nのオプション

署名:

typescript
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で削除されます

詳細

このオプションは、Vue I18n v8.xで提供されるVueI18nクラスコンストラクタオプションと互換性があります。

availableLocales

署名:

typescript
availableLocales?: Locale[];

詳細

メッセージにおける利用可能なロケールのリスト。語彙順です。

デフォルト値

[]

datetime

datetimeFormats

escapeParameterHtml

署名:

typescript
escapeParameterHtml?: Options['escapeParameter'];

詳細

リストまたは名前付き補間値のパラメータをエスケープするかどうか。有効にした場合、このオプションは次のように動作します:

  • インターポレーションパラメータのHTML特別文字(<, >, ", ', &, /, =)をエスケープします。
  • 翻訳後の最終的なHTMLをXSS攻撃から防ぐために次のようにサニタイズします:
    • HTML属性値の危険な文字をエスケープします。
    • イベントハンドラ属性(onclick、onerrorなど)を中和します。
    • href、src、action、formaction、およびstyle属性のjavascript: URLを無効にします。

これは、翻訳出力がv-htmlで使用され、翻訳リソースにHTMLマークアップ(ユーザー提供値の周囲など)が含まれている場合に便利です。

このような使用パターンは、事前に計算されたテキスト文字列をUIコンポーネントに渡す際によく発生します。

エスケープ処理では、以下の文字をそれぞれのHTML文字エンティティに置き換えます:<>"'

escapeParameterHtmlをtrueに設定しても既存の機能は壊れませんが、微細なXSS攻撃ベクトルに対する保護を提供します。

デフォルト値

false

関連項目

fallbackLocale

署名:

typescript
fallbackLocale?: Options['fallbackLocale'];

詳細

フォールバックローカライズのロケールです。

より複雑なフォールバック定義についてはfallbackを参照してください。

デフォルト値

localeが指定されていない場合のデフォルト'en-US'、またはそれがlocaleの値です。

関連項目

fallbackRoot

署名:

typescript
fallbackRoot?: Options['fallbackRoot'];

詳細

コンポーネントローカライズにおいて、ローカライズが失敗した場合にルートレベル(グローバルスコープ)ローカライズにフォールバックするかどうかです。

falseの場合、ルートにフォールバックしません。

デフォルト値

true

関連項目

flatJson

署名:

typescript
flatJson?: Options['flatJson'];

詳細

フラットJSONメッセージの使用を許可するかどうかです。

デフォルト値

false

formatFallbackMessages

署名:

typescript
formatFallbackMessages?: Options['fallbackFormat'];

詳細

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

デフォルト値

false

関連項目

locale

署名:

typescript
locale?: Options['locale'];

詳細

ローカライズのロケールです。

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

デフォルト値

'en-US'

関連項目

message

messageResolver

署名:

typescript
messageResolver?: MessageResolver;

詳細

messagesを解決するためのメッセージリゾルバです。

指定されていない場合、vue-i18nの内部メッセージリゾルバがデフォルトで使用されます。

以下のような要件を満たすメッセージリゾルバを自分で実装する必要があります:

  • メッセージリゾルバの第一引数として渡されたlocaleのロケールメッセージと第二引数として渡されたパスを使用してメッセージを解決します。
  • メッセージが解決できない場合はnullを返す必要があります。
  • nullを返す場合、fallbackLocaleが有効な場合はフォールバックでもメッセージリゾルバが呼び出されるため、メッセージも解決する必要があります。

メッセージリゾルバは以下のAPIによって間接的に呼び出されます:

TIP

🆕 v9.2+

WARNING

メッセージリゾルバを使用する場合、flatJson設定は無視されます。つまり、フラットJSONを自分で解決する必要があります。

デフォルト値

undefined

関連項目

createI18nで設定する方法の例です:

js
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

署名:

typescript
missing?: Options['missing'];

詳細

ローカライズ不足のハンドラです。

ハンドラはローカライズ対象ロケール、ローカライズパスキー、Vueインスタンス、および値とともに呼び出されます。

不足ハンドラが割り当てられ、ローカライズ不足が発生した場合は警告が出力されません。

デフォルト値

null

modifiers

署名:

typescript
modifiers?: Options['modifiers'];

詳細

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

関連項目

number

numberFormats

pluralizationRules

署名:

typescript
pluralizationRules?: Options['pluralRules'];

詳細

単語の複数形規則のセットです。

デフォルト値

{}

関連項目

postTranslation

署名:

typescript
postTranslation?: Options['postTranslation'];

詳細

翻訳後の処理のハンドラです。ハンドラは$tおよびtの呼び出し後に呼び出されます。

このハンドラは、スペースのトリミングなどの翻訳済みテキストをフィルタリングしたい場合に便利です。

デフォルト値

null

sharedMessages

署名:

typescript
sharedMessages?: LocaleMessages<VueMessageType>;

詳細

コンポーネントのローカライズの共有ロケールメッセージです。詳細についてはコンポーネントベースローカライズを参照してください。

デフォルト値

undefined

関連項目

silentFallbackWarn

署名:

typescript
silentFallbackWarn?: Options['fallbackWarn'];

詳細

言語にキーの翻訳がない場合にテンプレート補間を行うかどうかです。

trueの場合、"基本"言語のテンプレートを書くことをスキップし、キーがテンプレートになります。

デフォルト値

false

関連項目

silentTranslationWarn

署名:

typescript
silentTranslationWarn?: Options['missingWarn'];

詳細

ローカライズに失敗したときに警告を抑制するかどうかです。

trueの場合、ローカライズ失敗警告を抑制します。

正規表現を使用すると、翻訳キー(例:t)に一致するローカライズ失敗警告を抑制できます。

デフォルト値

false

関連項目

sync

署名:

typescript
sync?: boolean;

詳細

ルートレベルのロケールをコンポーネントローカライズロケールに同期するかどうかです。

falseの場合、ルートレベルのロケールに関係なく、各コンポーネントロケールにローカライズします。

デフォルト値

true

関連項目

warnHtmlInMessage

署名:

typescript
warnHtmlInMessage?: WarnHtmlInMessageLevel;

詳細

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

warnHtmlInMessageプロパティを参照してください。

デフォルト値

'off'

関連項目

VueI18nResolveLocaleMessageTranslation

VueI18nレガシーインターフェースのロケールメッセージ翻訳の解決関数

署名:

typescript
export type VueI18nResolveLocaleMessageTranslation<Locales = 'en-US'> = ComposerResolveLocaleMessageTranslation<Locales>;

非推奨

vue-i18n v12で削除されます

詳細

これはVueI18nのインターフェースです。このインターフェースはComposerResolveLocaleMessageTranslationの別名です。

VueI18nTranslation

VueI18nレガシーインターフェースのロケールメッセージ翻訳関数

署名:

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

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

署名:

typescript
<Key extends string>(key: Key | ResourceKeys): TranslateResult;

詳細

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

i18nコンポーネントオプションが指定されている場合、グローバルスコープのロケールメッセージよりもローカルスコープのロケールメッセージを優先的に翻訳します。

i18nコンポーネントオプションが指定されていない場合、グローバルスコープのロケールメッセージで翻訳します。

関連項目

パラメータ

パラメータタイプ説明
keyKey | ResourceKeys対象のロケールメッセージキー

戻り値

翻訳されたメッセージ

(key: Key | ResourceKeys, named: Record<string, unknown>): TranslateResult;

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

署名:

typescript
<Key extends string>(key: Key | ResourceKeys, named: Record<string, unknown>): TranslateResult;

詳細

オーバーロードされたt。詳細は呼び出しシグネチャの詳細を参照してください。

関連項目

パラメータ

パラメータタイプ説明
keyKey | ResourceKeys対象のロケールメッセージキー
namedRecord<string, unknown>名前付き補間の値

戻り値

翻訳されたメッセージ

(key: Key | ResourceKeys, named: NamedValue, plural: number): TranslateResult;

名前付き補間と複数形のロケールメッセージ翻訳

署名:

typescript
<Key extends string>(key: Key | ResourceKeys, named: NamedValue, plural: number): TranslateResult;

詳細

オーバーロードされたt。詳細は呼び出しシグネチャの詳細を参照してください。

このオーバーロードされたtでは、各プレースホルダーxについて、ロケールメッセージには{x}トークンが含まれており、複数形化された翻訳メッセージを返します。

関連項目

パラメータ

パラメータタイプ説明
keyKey | ResourceKeys対象のロケールメッセージキー
namedNamedValue名前付き補間の値
pluralnumberどの複数形文字列を取得するか。1は最初のものを返します。

戻り値

翻訳されたメッセージ

(key: Key | ResourceKeys, named: NamedValue, defaultMsg: string): TranslateResult;

名前付き補間と複数形のロケールメッセージ翻訳

署名:

typescript
<Key extends string>(key: Key | ResourceKeys, named: NamedValue, defaultMsg: string): TranslateResult;

詳細

オーバーロードされたt。詳細は呼び出しシグネチャの詳細を参照してください。

このオーバーロードされたtでは、各プレースホルダーxについて、ロケールメッセージには{x}トークンが含まれており、翻訳が見つからない場合はデフォルトメッセージを返します。

関連項目

パラメータ

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

戻り値

翻訳されたメッセージ

(key: Key | ResourceKeys, named: NamedValue, options: TranslateOptions<Locales>): TranslateResult;

名前付き補間のロケールメッセージ翻訳

署名:

typescript
<Key extends string>(key: Key | ResourceKeys, named: NamedValue, options: TranslateOptions<Locales>): TranslateResult;

詳細

オーバーロードされたt。詳細は呼び出しシグネチャの詳細を参照してください。

このオーバーロードされたtでは、各プレースホルダーxについて、ロケールメッセージには{x}トークンが含まれています。

また、オプションに従って翻訳が見つからない場合の警告を抑制することもできます。

オプションの詳細については、を参照してください。

関連項目

パラメータ

パラメータタイプ説明
keyKey | ResourceKeys対象のロケールメッセージキー
namedNamedValue名前付き補間の値
optionsTranslateOptions<Locales>翻訳の追加

戻り値

翻訳されたメッセージ

(key: Key | ResourceKeys, plural: number): TranslateResult;

複数形のロケールメッセージ翻訳

署名:

typescript
<Key extends string>(key: Key | ResourceKeys, plural: number): TranslateResult;

詳細

オーバーロードされたt。詳細は呼び出しシグネチャの詳細を参照してください。

このオーバーロードされたtでは、複数形化された翻訳メッセージを返します。

また、オプションに従って翻訳が見つからない場合の警告を抑制することもできます。

関連項目

パラメータ

パラメータタイプ説明
keyKey | ResourceKeys対象のロケールメッセージキー
pluralnumberどの複数形文字列を取得するか。1は最初のものを返します。

戻り値

翻訳されたメッセージ

(key: Key | ResourceKeys, plural: number, options: TranslateOptions<Locales>): TranslateResult;

複数形のロケールメッセージ翻訳

署名:

typescript
<Key extends string>(key: Key | ResourceKeys, plural: number, options: TranslateOptions<Locales>): TranslateResult;

詳細

オーバーロードされたt。詳細は呼び出しシグネチャの詳細を参照してください。

このオーバーロードされたtでは、複数形化された翻訳メッセージを返します。

また、オプションに従って翻訳が見つからない場合の警告を抑制することもできます。

オプションの詳細については、を参照してください。

関連項目

パラメータ

パラメータタイプ説明
keyKey | ResourceKeys対象のロケールメッセージキー
pluralnumberどの複数形文字列を取得するか。1は最初のものを返します。
optionsTranslateOptions<Locales>翻訳の追加

戻り値

翻訳されたメッセージ

(key: Key | ResourceKeys, defaultMsg: string): TranslateResult;

欠失デフォルトメッセージのロケールメッセージ翻訳

署名:

typescript
<Key extends string>(key: Key | ResourceKeys, defaultMsg: string): TranslateResult;

詳細

オーバーロードされたt。詳細は呼び出しシグネチャの詳細を参照してください。

このオーバーロードされたtでは、翻訳が見つからない場合にデフォルトメッセージを返します。

また、オプションに従って翻訳が見つからない場合の警告を抑制することもできます。

パラメータ

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

戻り値

翻訳されたメッセージ

(key: Key | ResourceKeys, defaultMsg: string, options: TranslateOptions<Locales>): TranslateResult;

欠失デフォルトメッセージのロケールメッセージ翻訳

署名:

typescript
<Key extends string>(key: Key | ResourceKeys, defaultMsg: string, options: TranslateOptions<Locales>): TranslateResult;

詳細

オーバーロードされたt。詳細は呼び出しシグネチャの詳細を参照してください。

このオーバーロードされたtでは、翻訳が見つからない場合にデフォルトメッセージを返します。

また、オプションに従って翻訳が見つからない場合の警告を抑制することもできます。

オプションの詳細については、を参照してください。

パラメータ

パラメータタイプ説明
keyKey | ResourceKeys対象のロケールメッセージキー
defaultMsgstring翻訳が見つからない場合に返すデフォルトメッセージ
optionsTranslateOptions<Locales>翻訳の追加

戻り値

翻訳されたメッセージ

(key: Key | ResourceKeys, list: unknown[]): TranslateResult;

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

署名:

typescript
<Key extends string>(key: Key | ResourceKeys, list: unknown[]): TranslateResult;

詳細

オーバーロードされたt。詳細は呼び出しシグネチャの詳細を参照してください。

関連項目

パラメータ

パラメータタイプ説明
keyKey | ResourceKeys対象のロケールメッセージキー
listunknown[]リスト補間の値

戻り値

翻訳されたメッセージ

(key: Key | ResourceKeys, list: unknown[], plural: number): TranslateResult;

リスト補間と複数形のロケールメッセージ翻訳

署名:

typescript
<Key extends string>(key: Key | ResourceKeys, list: unknown[], plural: number): TranslateResult;

詳細

オーバーロードされたt。詳細は呼び出しシグネチャの詳細を参照してください。

このオーバーロードされたtでは、リストの各プレースホルダーに対して{0}{1}、…がロケールメッセージに含まれており、複数形化された翻訳メッセージを返します。

関連項目

パラメータ

パラメータタイプ説明
keyKey | ResourceKeys対象のロケールメッセージキー
listunknown[]リスト補間の値
pluralnumberどの複数形文字列を取得するか。1は最初のものを返します。

戻り値

翻訳されたメッセージ

(key: Key | ResourceKeys, list: unknown[], defaultMsg: string): TranslateResult;

リスト補間と欠失デフォルトメッセージのロケールメッセージ翻訳

署名:

typescript
<Key extends string>(key: Key | ResourceKeys, list: unknown[], defaultMsg: string): TranslateResult;

詳細

オーバーロードされたt。詳細は呼び出しシグネチャの詳細を参照してください。

このオーバーロードされたtでは、リストの各プレースホルダーに対して{0}{1}、…がロケールメッセージに含まれており、翻訳が見つからない場合はデフォルトメッセージを返します。

関連項目

パラメータ

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

戻り値

翻訳されたメッセージ

(key: Key | ResourceKeys, list: unknown[], options: TranslateOptions<Locales>): TranslateResult;

リスト補間のロケールメッセージ翻訳

署名:

typescript
<Key extends string>(key: Key | ResourceKeys, list: unknown[], options: TranslateOptions<Locales>): TranslateResult;

詳細

オーバーロードされたt。詳細は呼び出しシグネチャの詳細を参照してください。

このオーバーロードされたtでは、リストの各プレースホルダーに対して{0}{1}、…がロケールメッセージに含まれています。

また、オプションに従って翻訳が見つからない場合の警告を抑制することもできます。

オプションの詳細については、を参照してください。

関連項目

パラメータ

パラメータタイプ説明
keyKey | ResourceKeys対象のロケールメッセージキー
listunknown[]リスト補間の値
optionsTranslateOptions<Locales>翻訳の追加

戻り値

翻訳されたメッセージ

WarnHtmlInMessageLevel

署名:

typescript
export type WarnHtmlInMessageLevel = 'off' | 'warn' | 'error';

非推奨

vue-i18n v12で削除されます