Skip to content

vue-i18n / general / MessageContext

インターフェース: MessageContext<T>

メッセージコンテキストです。

Vue I18n General

型パラメータ

型パラメータデフォルト型
Tstring

メソッド

linked()

呼び出しシグネチャ

ts
linked(key, modifier?): MessageType<T>;

リンクされたメッセージを解決します。

パラメータ
パラメータ説明
keystringメッセージキー
modifier?stringモディファイア
戻り値

MessageType<T>

解決されたメッセージ。

呼び出しシグネチャ

ts
linked(
   key,
   modifier?,
type?): MessageType<T>;

オーバーロードされた linked

パラメータ
パラメータ説明
keystringメッセージキー
modifier?stringモディファイア
type?stringメッセージタイプ
戻り値

MessageType<T>

解決されたメッセージ。

呼び出しシグネチャ

ts
linked(key, options?): MessageType<T>;

オーバーロードされた linked

パラメータ
パラメータ説明
keystringメッセージキー
options?LinkedOptionsLinkedOptions またはリンクオプション
戻り値

MessageType<T>

解決されたメッセージ。


list()

ts
list(index): unknown;

リストからメッセージ値を解決します。

パラメータ

パラメータ説明
indexnumberメッセージ値のインデックス。

戻り値

unknown

解決されたメッセージ値。

js
const messages = {
  en: {
    greeting: ({ list }) => `hello, ${list(0)}!`
  }
}

named()

ts
named(key): unknown;

名前付きからメッセージ値を解決します。

パラメータ

パラメータ説明
keystringメッセージ値のキー。

戻り値

unknown

解決されたメッセージ値。

js
const messages = {
  en: {
    greeting: ({ named }) => `hello, ${named('name')}!`
  }
}

plural()

ts
plural(messages): T;

複数形インデックスでメッセージを解決します。

パラメータ

パラメータ説明
messagesT[]複数形インデックスで解決されるメッセージ、翻訳関数で。

戻り値

T

解決されたメッセージ。

備考

これは翻訳関数で複数形インデックスで解決されます。

js
const messages = {
  en: {
    car: ({ plural }) => plural(['car', 'cars']),
    apple: ({ plural, named }) =>
      plural([
        'no apples',
        'one apple',
        `${named('count')} apples`
      ])
  }
}

プロパティ

type

ts
type: string;

メッセージ関数で処理されるメッセージタイプです。

備考

通常は text であり、メッセージ関数では文字列を返す必要があります。


values

ts
values: Record<string, unknown>;

メッセージ値です。

備考

メッセージ値とは、翻訳関数(たとえば $tt、または translate)から渡される引数値です。

vue-i18n $t(または t)の場合:

html
<p>{{ $t('greeting', { name: 'DIO' }) }}</p> <!-- `{ name: 'DIO' }` はメッセージ値です -->

@intlify/core@intlify/core-base)の translate の場合:

js
translate(context, 'foo.bar', ['dio']) // `['dio']` はメッセージ値です