API

Vue I18n

Vue I18n 的扩展
Composer(用于组合式 API)VueI18n(用于传统 API) 的实例在 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,该 Promise 在待定语言设置后解析。

strategy

  • 类型: Strategies

根据选项指定的路由策略。

defaultDirection

  • 类型: Directions

根据选项指定的默认方向。

defaultLocale

  • 类型: string

根据选项指定的默认语言环境。

localeCodes

  • 类型: Array<string>

注册语言环境的语言代码列表。

locales

  • 类型: Array<string | LocaleObject>

根据选项定义的语言环境列表。

localeProperties

  • 类型: LocaleObject

当前语言环境属性的对象。

differentDomains

  • 类型: boolean

differentDomains 选项是否已启用。