组件注入
ComponentCustomOptions
Vue I18n 的组件自定义选项
签名：
export interface ComponentCustomOptions;i18n
组件的 Vue I18n 选项
签名：
i18n?: VueI18nOptions;另请参阅
ComponentCustomProperties
Vue I18n 的组件自定义选项
签名：
export interface ComponentCustomProperties;详情
这些属性被注入到每个子组件中
$i18n
导出的全局 Composer 实例，或全局 VueI18n 实例。
签名：
$i18n: VueI18n | ExportedGlobalComposer;详情
您可以获取从使用 createI18n 创建的全局 composer 实例导出的 exported composer instance，或全局 VueI18n 实例。
您可以在 组合式 API 模式 下获取导出的 composer 实例，或者在 Legacy API 模式 下获取 Vuei18n 实例，这是您可以使用此属性引用的实例。
由此属性引用的实例管理的语言环境、语言环境消息和其他资源在全局范围内有效。
如果未指定 i18n 组件选项，则与可以通过 i18n 实例 global 引用的 VueI18n 实例相同。
另请参阅
$t(key)
语言环境消息翻译
签名：
$t(key: Key): TranslateResult;详情
如果在响应式上下文中使用，它将在语言环境更改后重新评估。
在 组合式 API 模式 下，$t 由 app.config.globalProperties 注入。输入/输出与 Composer 相同，并且它在全局作用域上工作。关于该详细信息，请参阅 Composer#t。
在 Legacy API 模式 下，输入/输出与 VueI18n 实例相同。关于详细信息，请参阅 VueI18n#t。
另请参阅
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| key | Key | 目标语言环境消息键 |
返回值
翻译消息
$t(key, locale)
注意
此 API 签名仅在 Legacy API 模式下可用，并且支持直到 v9。
语言环境消息翻译
签名：
$t(key: Key, locale: Locale): TranslateResult;详情
重载的 $t。关于详细信息，请参阅 $t 说明。
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| key | Key | 目标语言环境消息键 |
| locale | Locale | 语言环境，覆盖全局作用域或本地作用域 |
返回值
翻译消息
$t(key, locale, list)
注意
此 API 签名仅在 Legacy API 模式下可用，并且支持直到 v9。
语言环境消息翻译
签名：
$t(key: Key, locale: Locale, list: unknown[]): TranslateResult;详情
重载的 $t。关于详细信息，请参阅 $t 说明。
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| key | Key | 目标语言环境消息键 |
| locale | Locale | 语言环境，覆盖全局作用域或本地作用域 |
| list | unknown[] | 列表插值的值 |
返回值
翻译消息
$t(key, locale, named)
注意
此 API 签名仅在 Legacy API 模式下可用，并且支持直到 v9。
语言环境消息翻译
签名：
$t(key: Key, locale: Locale, named: object): TranslateResult;详情
重载的 $t。关于详细信息，请参阅 $t 说明。
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| key | Key | 目标语言环境消息键 |
| locale | Locale | 语言环境，覆盖全局作用域或本地作用域 |
| named | object | 命名插值的值 |
返回值
翻译消息
$t(key, plural)
语言环境消息翻译
签名：
$t(key: Key, plural: number): TranslateResult;注意
仅支持 组合式 API 模式直到 v9。v10 或更高版本也可以在 Legacy API 模式下使用。
详情
重载的 $t。关于详细信息，请参阅 $t 说明。
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| key | Key | 目标语言环境消息键 |
| plural | number | 复数选择数字 |
返回值
翻译消息
$t(key, plural, options)
语言环境消息翻译
签名：
$t(key: Key, plural: number, options: TranslateOptions): TranslateResult;注意
仅支持 组合式 API 模式直到 v9。v10 或更高版本也可以在 Legacy API 模式下使用。
详情
重载的 $t。关于详细信息，请参阅 $t 说明。
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| key | Key | 目标语言环境消息键 |
| plural | number | 复数选择数字 |
| options | TranslateOptions | 选项，请参阅 TranslateOptions |
返回值
翻译消息
$t(key, defaultMsg)
语言环境消息翻译
签名：
$t(key: Key, defaultMsg: string): TranslateResult;注意
仅支持 组合式 API 模式直到 v9。v10 或更高版本也可以在 Legacy API 模式下使用。
详情
重载的 $t。关于详细信息，请参阅 $t 说明。
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| key | Key | 目标语言环境消息键 |
| defaultMsg | string | 如果未找到翻译则返回的默认消息 |
返回值
翻译消息
$t(key, defaultMsg, options)
语言环境消息翻译
签名：
$t(key: Key, defaultMsg: string, options: TranslateOptions): TranslateResult;注意
仅支持 组合式 API 模式直到 v9。v10 或更高版本也可以在 Legacy API 模式下使用。
详情
重载的 $t。关于详细信息，请参阅 $t 说明。
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| key | Key | 目标语言环境消息键 |
| defaultMsg | string | 如果未找到翻译则返回的默认消息 |
| options | TranslateOptions | 选项，请参阅 TranslateOptions |
返回值
翻译消息
$t(key, list)
语言环境消息翻译
签名：
$t(key: Key, list: unknown[]): TranslateResult;详情
重载的 $t。关于详细信息，请参阅 $t 说明。
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| key | Key | 目标语言环境消息键 |
| list | unknown[] | 列表插值的值 |
返回值
翻译消息
$t(key, list, plural)
语言环境消息翻译
签名：
$t(key: Key, list: unknown[], plural: number): TranslateResult;注意
仅支持 组合式 API 模式直到 v9。v10 或更高版本也可以在 Legacy API 模式下使用。
详情
重载的 $t。关于详细信息，请参阅 $t 说明。
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| key | Key | 目标语言环境消息键 |
| list | unknown[] | 列表插值的值 |
| plural | number | 复数选择数字 |
返回值
翻译消息
$t(key, list, defaultMsg)
语言环境消息翻译
签名：
$t(key: Key, list: unknown[], defaultMsg: string): TranslateResult;注意
仅支持 组合式 API 模式直到 v9。v10 或更高版本也可以在 Legacy API 模式下使用。
详情
重载的 $t。关于详细信息，请参阅 $t 说明。
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| key | Key | 目标语言环境消息键 |
| list | unknown[] | 列表插值的值 |
| defaultMsg | string | 如果未找到翻译则返回的默认消息 |
返回值
翻译消息
$t(key, list, options)
语言环境消息翻译
签名：
$t(key: Key, list: unknown[], options: TranslateOptions): TranslateResult;注意
仅支持 组合式 API 模式直到 v9。v10 或更高版本也可以在 Legacy API 模式下使用。
详情
重载的 $t。关于详细信息，请参阅 $t 说明。
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| key | Key | 目标语言环境消息键 |
| list | unknown[] | 列表插值的值 |
| options | TranslateOptions | 选项，请参阅 TranslateOptions |
返回值
翻译消息
$t(key, named)
语言环境消息翻译
签名：
$t(key: Key, named: NamedValue): TranslateResult;详情
重载的 $t。关于详细信息，请参阅 $t 说明。
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| key | Key | 目标语言环境消息键 |
| named | NamedValue | 命名插值的值 |
返回值
翻译消息
$t(key, named, plural)
语言环境消息翻译
签名：
$t(key: Key, named: NamedValue, plural: number): TranslateResult;注意
仅支持 组合式 API 模式直到 v9。v10 或更高版本也可以在 Legacy API 模式下使用。
详情
重载的 $t。关于详细信息，请参阅 $t 说明。
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| key | Key | 目标语言环境消息键 |
| named | NamedValue | 命名插值的值 |
| plural | number | 复数选择数字 |
返回值
翻译消息
$t(key, named, defaultMsg)
语言环境消息翻译
签名：
$t(key: Key, named: NamedValue, defaultMsg: string): TranslateResult;注意
仅支持 组合式 API 模式直到 v9。v10 或更高版本也可以在 Legacy API 模式下使用。
详情
重载的 $t。关于详细信息，请参阅 $t 说明。
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| key | Key | 目标语言环境消息键 |
| named | NamedValue | 命名插值的值 |
| defaultMsg | string | 如果未找到翻译则返回的默认消息 |
返回值
翻译消息
$t(key, named, options)
语言环境消息翻译
签名：
$t(key: Key, named: NamedValue, options: TranslateOptions): TranslateResult;注意
仅支持 组合式 API 模式直到 v9。v10 或更高版本也可以在 Legacy API 模式下使用。
详情
重载的 $t。关于详细信息，请参阅 $t 说明。
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| key | Key | 目标语言环境消息键 |
| named | NamedValue | 命名插值的值 |
| options | TranslateOptions | 选项，请参阅 TranslateOptions |
返回值
翻译消息
$rt(message)
解析语言环境消息翻译
签名：
$rt(message: MessageFunction<VueMessageType> | VueMessageType): string;详情
如果在响应式上下文中使用，它将在语言环境更改后重新评估。
在 组合式 API 模式 下，$rt 由 app.config.globalProperties 注入。输入/输出与 Composer 相同，并且它在全局作用域上工作。关于该详细信息，请参阅 Composer#rt。
在 Legacy API 模式 下，输入/输出与 VueI18n 实例相同。关于详细信息，请参阅 VueI18n#rt。
另请参阅
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| message | MessageFunction<VueMessageType> | VueMessageType | 要解析的目标语言环境消息。您需要指定 $tm 返回的语言环境消息。 |
返回值
翻译消息
$rt(message, plural, options)
解析复数的语言环境消息翻译
签名：
$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)
解析列表插值的语言环境消息翻译
签名：
$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)
解析命名插值的语言环境消息翻译
签名：
$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)
翻译消息是否存在
签名：
$te(key: Key, locale?: Locale): boolean;详情
关于详细信息，请参阅 VueI18n#te
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| key | Key | 目标语言环境消息键 |
| locale | Locale | 可选，语言环境，覆盖全局作用域或本地作用域 |
返回值
如果找到语言环境消息，则为 true，否则为 false。
$tm(key)
语言环境消息获取器
签名：
$tm(key: Key): LocaleMessageValue<VueMessageType> | {}详情
如果指定了 i18n component options，则优先在本地作用域语言环境消息中获取，而不是全局作用域语言环境消息。
如果未指定 i18n component options，则使用全局作用域语言环境消息获取。
基于当前 locale，将从 Composer 实例消息返回语言环境消息。
如果您更改 locale，返回的语言环境消息也将对应于该语言环境。
如果 Composer 实例消息中没有给定 key 的语言环境消息，则将通过回退返回。
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| key | Key | 目标语言环境消息键 |
返回值
语言环境消息
注意
您需要对 $tm 返回的语言环境消息使用 $rt。
$d(value)
日期时间格式化
签名：
$d(value: number | Date): DateTimeFormatResult | string;详情
如果在响应式上下文中使用，它将在语言环境更改后重新评估。
在 组合式 API 模式 下，输入/输出与 VueI18n 实例相同。关于详细信息，请参阅 VueI18n#d。
在 组合式 API 模式 下，$d 由 app.config.globalProperties 注入。输入/输出与 Composer 实例相同，并且它在全局作用域上工作。关于该详细信息，请参阅 Composer#d。
另请参阅
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| value | number | Date | 值，时间戳数字或 Date 实例 |
返回值
格式化后的值
$d(value, key)
日期时间格式化
签名：
$d(value: number | Date, key: string): DateTimeFormatResult | string;详情
重载的 $d。关于详细信息，请参阅 $d 说明。
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| value | number | Date | 值，时间戳数字或 Date 实例 |
| key | string | 日期时间格式的键 |
返回值
格式化后的值
$d(value, key, locale)
日期时间格式化
签名：
$d(value: number | Date, key: string, locale: Locale): DateTimeFormatResult | string;详情
重载的 $d。关于详细信息，请参阅 $d 说明。
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| value | number | Date | 值，时间戳数字或 Date 实例 |
| key | string | 日期时间格式的键 |
| locale | Locale | 语言环境，覆盖全局作用域或本地作用域 |
返回值
格式化后的值
$d(value, args)
日期时间格式化
签名：
$d(value: number | Date, args: { [key: string]: string | boolean | number }): DateTimeFormatResult;详情
重载的 $d。关于详细信息，请参阅 $d 说明。
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| value | number | Date | 值，时间戳数字或 Date 实例 |
| args | { [key: string]: string } | 参数值 |
返回值
格式化后的值
$d(value, options)
日期时间格式化
签名：
$d(value: number | Date, options: DateTimeOptions): string;详情
重载的 $d。关于详细信息，请参阅 $d 说明。
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| value | number | Date | 值，时间戳数字或 Date 实例 |
| options | DateTimeOptions | 选项，请参阅 DateTimeOptions |
返回值
格式化后的值
$n(value)
数字格式化
签名：
$n(value: number): NumberFormatResult | string;详情
如果在响应式上下文中使用，它将在语言环境更改后重新评估。
在 Legacy API 模式 下，输入/输出与 VueI18n 实例相同。关于详细信息，请参阅 VueI18n#n。
在 组合式 API 模式 下，$n 由 app.config.globalProperties 注入。输入/输出与 Composer 实例相同，并且它在全局作用域上工作。关于该详细信息，请参阅 Composer#n。
另请参阅
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| value | number | 数字值 |
返回值
格式化后的值
$n(value, key)
数字格式化
签名：
$n(value: number, key: string): NumberFormatResult | string;详情
重载的 $n。关于详细信息，请参阅 $n 说明。
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| value | number | 数字值 |
| key | string | 数字格式的键 |
返回值
格式化后的值
$n(value, key, locale)
数字格式化
签名：
$n(value: number, key: string, locale: Locale): NumberFormatResult | string;详情
重载的 $n。关于详细信息，请参阅 $n 说明。
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| value | number | 数字值 |
| key | string | 数字格式的键 |
| locale | Locale | 语言环境，覆盖全局作用域或本地作用域 |
返回值
格式化后的值
$n(value, args)
数字格式化
签名：
$n(value: number, args: { [key: string]: string | boolean | number }): NumberFormatResult;详情
重载的 $n。关于详细信息，请参阅 $n 说明。
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| value | number | 数字值 |
| args | { [key: string]: string } | 参数值 |
返回值
格式化后的值
$n(value, key, args)
数字格式化
签名：
$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)
数字格式化
签名：
$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)
数字格式化
签名：
$n(value: number, options: NumberOptions): string;详情
重载的 $n。关于详细信息，请参阅 $n 说明。
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| value | number | 数字值 |
| options | NumberOptions | 选项，请参阅 NumberOptions |
返回值
格式化后的值