- VueI18n 类
- 静态属性
- 构造函数选项
- Properties
- 方法
- getChoiceIndex
- getLocaleMessage( locale )
- setLocaleMessage( locale, message )
- mergeLocaleMessage( locale, message )
- t( key, [locale], [values] )
- i( key, [locale], [values] )
- tc( key, [choice], [values] )
- te( key, [locale] )
- getDateTimeFormat ( locale )
- setDateTimeFormat ( locale, format )
- mergeDateTimeFormat ( locale, format )
- d( value, [key], [locale] )
- getNumberFormat ( locale )
- setNumberFormat ( locale, format )
- mergeNumberFormat ( locale, format )
- n( value, [key], [locale] )
VueI18n 类
Vuei18n
类实现了 I18n
flowtype 接口
静态属性
版本
- 类型:
string
vue-i18n 版本
可用性
🆕 7.0 新增
类型:
IntlAvailability
是否提供以下国际化功能:{boolean} dateTimeFormat
:环境敏感的时间格式{boolean} numberFormat
:环境敏感的数字格式
由于使用 ECMAScript Internationalization API (ECMA-402) 实现,上述国际化功能取决于浏览器环境。
构造函数选项
你可以基于flowtype 定义 中的 I18nOptions
指定下列构造函数选项
locale
类型:
Locale
默认值:
'en-US'
语言环境。
fallbackLocale
类型:
Locale
默认值:
'en-US'
预设的语言环境。
messages
类型:
LocaleMessages
默认值:
{}
本地化的语言环境信息。
dateTimeFormats
🆕 7.0 新增
类型:
DateTimeFormats
默认值:
{}
本地化的日期时间格式。
- 请参阅:
DateTimeFormats
类型的flowtype 接口
numberFormats
🆕 7.0 新增
类型:
NumberFormats
默认值:
{}
本地化的数字格式。
- 请参阅:
NumberFormats
类型的flowtype 接口
availableLocales
🆕 8.9.0 新增
类型:
Locale[]
默认值:
[]
示例:
["en", "ja"]
以词法顺序排列的 messages
中的可用语言环境列表。
formatter
类型:
Formatter
默认值: Built in formatter
使用 Formatter
接口实现的格式化。
missing
类型:
MissingHandler
默认值:
null
缺少本地化时的处理函数。该处理函数在被调用时会使用本地化目标语言环境,本地化路径关键字和 Vue 实例。
如果设置了该函数,则本地化信息未定义时不会产生警告。
fallbackRoot
类型:
Boolean
默认值:
true
在组件本地化中,当本地化失败时是否回退到根级别 (全局) 本地化。
如果为 false
,则会发出警告,并返回 key。
sync
类型:
Boolean
默认值:
true
是否将根级别语言环境与组件本地化语言环境同步。
如果为 false
,则无论根级别语言环境如何,都要为每个组件语言环境进行本地化。
silentTranslationWarn
6.1 新增
类型:
Boolean
默认值:
false
是否取消本地化失败时输出的警告。
如果为 true
,则禁止本地化失败警告。
silentFallbackWarn
🆕 8.8 新增
- 类型:
Boolean
- 默认值:
false
是否在回退到fallbackLocale
或root
时取消警告。
如果为 true
,则仅在根本没有可用的转换时生成警告,而不是在回退时。
preserveDirectiveContent
8.7 新增
类型:
Boolean
默认值:
false
在指令解除绑定后,v-t
指令的元素是否应该保留 textContent
。
Properties
locale
类型:
Locale
可读/可写
语言环境。
fallbackLocale
类型:
Locale
可读/可写
预设的语言环境。
messages
类型:
LocaleMessages
只读
本地化的语言环境信息。
dateTimeFormats
🆕 7.0 新增
类型:
DateTimeFormats
只读
本地化的日期时间格式。
numberFormats
🆕 7.0 新增
类型:
NumberFormats
只读
本地化的数字格式。
missing
类型:
MissingHandler
可读/可写
缺少本地化时的处理函数。
formatter
类型:
Formatter
可读/可写
使用 Formatter
接口实现的格式化。
silentTranslationWarn
6.1 新增
类型:
boolean
可读/可写
是否取消本地化失败时输出的警告。
preserveDirectiveContent
8.7 新增
类型:
boolean
可读/可写
在指令解除绑定后,v-t
指令的元素是否应该保留 textContent
。
方法
getChoiceIndex
参数:
{number} choice
{number} choicesLength
- 返回值:
finalChoice {number}
根据当前的数字和一组给定的选项,获取其复数索引,可以通过原型变更覆盖:
VueI18n.prototype.getChoiceIndex = /* 自定义实现 */
getLocaleMessage( locale )
参数:
{Locale} locale
- 返回值:
LocaleMessageObject
获取语言环境的 locale
信息。
setLocaleMessage( locale, message )
参数:
{Locale} locale
{LocaleMessageObject} message
设置语言环境的locale
信息。
mergeLocaleMessage( locale, message )
6.1 新增
参数:
{Locale} locale
{LocaleMessageObject} message
将语言环境信息locale
合并到已注册的语言环境信息中。
t( key, [locale], [values] )
参数:
{Path} key
:必填{Locale} locale
:可选{Array | Object} values
:可选
- 返回值::
TranslateResult
这与 $t
方法返回的 Function
相同。更多细节见$t。
i( key, [locale], [values] )
🆕 7.0 新增
参数:
{Path} key
:必填{Locale} locale
:可选{Array} values
:可选
- 返回值::
TranslateResult
tc( key, [choice], [values] )
参数:
{Path} key
:必填{number} choice
:可选,默认为 1{string | Array | Object} values
:可选
- 返回值:
TranslateResult
这与 $tc
方法返回的 Function
相同。更多细节见$tc。
te( key, [locale] )
参数:
{string} key
:必填{Locale} locale
:可选
- 返回值:
boolean
检查全局语言环境信息中是否存在键名路径。如果指定了 locale
,请检查语言环境信息 locale
。
getDateTimeFormat ( locale )
🆕 7.0 新增
参数:
{Locale} locale
- 返回值:
DateTimeFormat
获取语言环境的日期时间格式。
setDateTimeFormat ( locale, format )
🆕 7.0 新增
参数:
{Locale} locale
{DateTimeFormat} format
设置语言环境的日期时间格式。
mergeDateTimeFormat ( locale, format )
🆕 7.0 新增
参数:
{Locale} locale
{DateTimeFormat} format
将已注册的日期时间格式与语言环境的日期时间格式合并。
d( value, [key], [locale] )
🆕 7.0 新增
参数:
{number | Date} value
:必填{Path | Object} key
:可选{Locale | Object} locale
:可选
- 返回值:
DateTimeFormatResult
这与 Vue 实例方法的 $d
方法相同。更多细节见$d。
getNumberFormat ( locale )
🆕 7.0 新增
参数:
{Locale} locale
- 返回值:
NumberFormat
获取语言环境的数字格式。
setNumberFormat ( locale, format )
🆕 7.0 新增
参数:
{Locale} locale
{NumberFormat} format
设置语言环境的数字格式。
mergeNumberFormat ( locale, format )
🆕 7.0 新增
参数:
{Locale} locale
{NumberFormat} format
将已注册的数字格式与语言环境的数字格式合并。
n( value, [key], [locale] )
🆕 7.0 新增
参数:
{number} value
:必填{Path | Object} key
:可选{Locale} locale
:可选
- 返回值:
NumberFormatResult
这与 Vue 实例方法的 $n
方法相同。更多细节见$n。