API

Vue I18n

Vue I18n 的扩展
Composer(用于组合 API)Composer 或 VueI18n(用于传统 API)VueI18n 的实例暴露为 Vue 实例上的 $i18n

getLocaleCookie()

  • 参数
    • 无参数
  • 返回string | undefined

从存储的语言 Cookie 中返回语言代码。

setLocaleCookie()

  • 参数
    • locale (类型: string)
  • 返回undefined

使用指定的语言代码更新存储的语言 Cookie。如果想要切换语言,建议使用 setLocale

setLocale()

  • 参数
    • locale (类型: string)
  • 返回Promise<void>

将应用的语言切换到指定的语言代码。如果启用了 useCookie 选项,语言 Cookie 将会被更新为新值。如果启用了前缀(strategy 除了 no_prefix),将导航到新语言的路由。

loadLocaleMessages()

  • 参数
    • locale (类型: string)
  • 返回Promise<void>

加载指定语言代码的翻译消息。这仅在项目使用懒加载翻译时相关,特别是当从未加载的语言获取翻译时。

getBrowserLocale()

  • 参数
    • 无参数
  • 返回string | undefined

返回根据选项中定义的浏览器语言代码进行筛选的语言代码。

finalizePendingLocaleChange()

  • 参数
    • 无参数
  • 返回Promise<void>

切换到挂起的语言,该语言应该是在导航时设置的,但由于选项 skipSettingLocaleOnNavigate 被阻止。有关更多信息,请参阅 等待页面转换

waitForPendingLocaleChange()

  • 参数
    • 无参数
  • 返回Promise<void>

返回一个 Promise,一旦挂起的语言设置完成,将被解决。

strategy

  • 类型: Strategies

按选项指定的路由策略。

defaultDirection

  • 类型: Directions

按选项指定的默认方向。

defaultLocale

  • 类型: string

按选项指定的默认语言。

localeCodes

  • 类型: Array<string>

已注册语言的语言代码列表。

locales

  • 类型: Array<string | LocaleObject>

按选项定义的语言列表。

localeProperties

  • 类型: LocaleObject

当前语言属性的对象。

differentDomains

  • 类型: boolean

differentDomains 选项是否启用。