# Installation

# Compatibility Note

  • Vue.js 2.0.0+

# Direct Download / CDN

https://unpkg.com/vue-i18n@8 (opens new window)

unpkg.com (opens new window) provides NPM-based CDN links. The above link will always point to the latest release on NPM. You can also use a specific version/tag via URLs like https://unpkg.com/vue-i18n@8.26.7/dist/vue-i18n.js (opens new window)

Include vue-i18n after Vue and it will install itself automatically:

<script src="https://unpkg.com/vue/dist/vue.js"></script>
<script src="https://unpkg.com/vue-i18n@8"></script>

# NPM

npm install vue-i18n

# Yarn

yarn add vue-i18n

When using with a module system, you must explicitly install the vue-i18n via Vue.use():

import Vue from 'vue'
import VueI18n from 'vue-i18n'

Vue.use(VueI18n)

You don't need to do this when using global script tags <script>.

# Vue Cli 3.x

vue add i18n

You need Vue cli 3.x as pre-requisite, you can install it on your shell with the next command:

npm install @vue/cli -g

# Dev Build

You will have to clone directly from GitHub and build vue-i18n yourself if you want to use the latest dev build.

git clone https://github.com/kazupon/vue-i18n.git node_modules/vue-i18n
cd node_modules/vue-i18n
npm install # or `yarn`
npm run build  # or `yarn run build`

# Explanation of Different Builds

In the dist/ directory of the NPM package (opens new window) you will find many different builds of VueI18n. Here’s an overview of the difference between them:

  • UMD: vue-i18n.js
  • CommonJS: vue-i18n.common.js
  • ES Module for bundlers: vue-i18n.esm.js
  • ES Module for browsers: vue-i18n.esm.browser.js

# Terms