# Installation

# Vue CLI Setup

You can easily setup your Vue Class Component project by using Vue CLI. Run the following command to create a new project:

$ vue create hello-world

You will be asked whether using preset or not. Select "Manually select features":

Check TypeScript feature to use Vue Class Component. You can add other features in addition if you need:

Press y for the question Use class-style component syntax?:

You can answer the remaining questions as your preferences. After finishing this setup process, Vue CLI creates a new project directory with Vue Class Component installed.

# Manual Setup

If you prefer manual setup, install it via npm and configure your build tool.

# npm

You can install Vue Class Component with npm command. Please make sure to also install Vue core library as Vue Class Component depends on it:

$ npm install --save vue vue-class-component

You can use yarn command if you prefer:

$ yarn add --save vue vue-class-component

# Build Setup

To use Vue Class Component, you need to configure TypeScript or Babel in your project as it relies on ECMAScript stage 1 decorators which is needed to transpile to run on browsers.


It does not support the stage 2 decorators yet since TypeScript transpiler still only supports the old decorators spec.

# TypeScript

Create tsconfig.json on your project root and specify experimentalDecorators option so that it transpiles decorator syntax:

  "compilerOptions": {
    "target": "es5",
    "module": "es2015",
    "moduleResolution": "node",
    "strict": true,
    "experimentalDecorators": true

# Babel

Install @babel/plugin-proposal-decorators and @babel/plugin-proposal-class-properties:

$ npm install --save-dev @babel/plugin-proposal-decorators @babel/plugin-proposal-class-properties

Then configure .babelrc on your project root:

  "plugins": [
    ["@babel/proposal-decorators", { "legacy": true }],
    ["@babel/proposal-class-properties", { "loose": true }]

Note that legacy and loose option are needed as Vue Class Component only supports stage 1 (legacy) decorator spec yet.


unpkg.com provides npm-based CDN links. You can choose specific version of Vue Class Component by replacing the @latest part in url (e.g. https://unpkg.com/vue-class-component@7.2.2/dist/vue-class-component.js to use version 7.2.2).

<!-- UMD build -->
<script src="https://unpkg.com/vue-class-component@latest/dist/vue-class-component.js"></script>

<!-- UMD minified build -->
<script src="https://unpkg.com/vue-class-component@latest/dist/vue-class-component.min.js"></script>

<!-- ES Module build -->
<script src="https://unpkg.com/vue-class-component@latest/dist/vue-class-component.esm.browser.js"></script>

<!-- ES Module minified build -->
<script src="https://unpkg.com/vue-class-component@latest/dist/vue-class-component.esm.browser.min.js"></script>

# Different Builds

Vue Class Component is provided as different builds for different environments and usages.

  • For development
    • vue-class-component.js (UMD)
    • vue-class-component.common.js (CommonJS)
    • vue-class-component.esm.js (ES Module for bundlers)
    • vue-class-component.esm.browser.js (ES Module for browsers)
  • For production (minified)
    • vue-class-component.min.js (UMD)
    • vue-class-component.esm.browser.min.js (ES Module for browsers)