Introduction to the configuration of using Typescript in Vue2 Vue-cli

This article mainly introduces the configuration introduction of using Typescript in Vue2 Vue-cli. It has a certain reference value. Now I share it with you. Friends in need can refer to it.

Vue is the three major front-end One of the frameworks has received 44,873 stars on github so far, which is enough to show that it has quietly become mainstream. The following article mainly introduces you to the relevant information about the configuration of using Typescript in Vue2 Vue-cli. Friends in need can refer to it.

Preface

Because the company's team is keen on the vue framework recently, and I want to practice typescript in the new project, so I started to work on vue ts The road to pitfalls... This article is intended to save time for friends who have the same idea as me. I won’t say much below. Let’s take a look at the configuration required to use Typescript in Vue2 Vue-cli. .

1. Preliminary configuration

First install the official plug-ins vue-class-component, vue-property-decorator, and configure webpack.
The webpack configuration is as follows:

Modify the entry file

entry: {
 app: './src/main.ts'
}

resolve part:

extensions: ['.js', '.vue', '.json', '.ts', '.tsx']

Configure loader

{
 test: /\.tsx?$/,
 loader: 'ts-loader',
 exclude: /node_modules/,
 options: {
  appendTsSuffixTo: [/\.vue$/],
 }
 }

Configure tsconfig.json

{
 "include": [
 "src/**/*"
 ],
 "exclude": [
 "node_modules"
 ],
 "compilerOptions": {
 "allowSyntheticDefaultImports": true,
 "experimentalDecorators": true,
 "allowJs": true,
 "module": "es2015",
 "target": "es5",
 "moduleResolution": "node",
 "experimentalDecorators": true,
 "isolatedModules": true,
 "lib": [
  "dom",
  "es5",
  "es2015.promise"
 ],
 "sourceMap": true,
 "pretty": true
 }
}

2. Actual combat!

# Configuring the configuration is only the first step, running it in the project is the key.

Add lang='ts'

# in the script tag of the vue file because ts-loader does not know it like webpack that has been equipped with loader What are vue, html and other files? When you run it, you will get an error that the module cannot be parsed, so you also need to configure the .d.ts declaration file

The following configuration of vue

declare module "*.vue" {
 import Vue from 'vue';
 export default Vue;
}

You can also configure .d.ts files for other non-js modules such as html (tell ts-loader to understand html as a string)

declare module "*.html" {
 let template: string;
 export default template;
}

After configuration, ts will be able to understand these modules

Introduce the modules that need to be used from vue-property-decorator

(Generally, only Component, Vue, Watch, and Prop are used. The other three are not used or studied. Someone who knows can explain it.)

import { Component, Vue, Watch } from 'vue-property-decorator'

Let’s take the previously written sidbar code as an example:

class HoverTopElem {
 leaveTop: number = -200
 top: number = null
 height: number = null

 show(e) {
 this.top = e.target.getBoundingClientRect().top
 this.height = e.target.clientHeight
 }
 hidden() {
 this.top = this.leaveTop
 }
}

@Component({
 name: 'sidebar',
 template: template,
 components: {
 sidebarItem
 }
})
export default class Sidebar extends Vue {
 SidebarMenu: any = SidebarMenu
 hoverTopElem: HoverTopElem = new HoverTopElem()
 activeListItemName: string = null
 activeRouteItemRoute: string = null

 get _activeRouteItemRoute(): string {
 return this.$route.path
 }

 @Watch('_activeRouteItemRoute', { immediate: true })
 onRouteChanged(val: any) {
 this.activeRouteItemRoute = val
 }

 changeList(param) {
 this.activeListItemName = param
 }

 changeRoute(param) {
 this.activeRouteItemRoute = param
 }
}

Metadata is written in the @Component configuration, such as name, components used, etc. Then let’s talk about how to use each instance attribute method used in vue before:

data: This is the most commonly used, like the SidebarMenu above (a total of 4 are declared here). Note that the variables declared here must be assigned a value. If not, it will be null, not undefined, otherwise the data will not be responsive. Therefore, the properties in the HoverTopElem class must also have initial values, otherwise these properties will not be responsive.

computed: Here is the get function. Note that tsconfig.jsonp is not configured with "target": "es5" and an error will be reported here

prop: There is a Prop module in vue-property-decorator. You can also declare this prop in the metadata, and then declare this variable in the class. I personally recommend the first one

watch: Watch module in vue-property-decorator

methods: Just write the method directly in the class like data (be careful not to have the same name as the cycle hook)

Various life cycles Hook: Just write it directly

See the vue-class-component document for routing hook

At this point, you can basically write the vue component as before.

Of course, if you want to write ts as before, you also need to configure tslint, otherwise some ts syntax will not be recognized, such as public modifiers, etc., because I am not very proficient in ts, so I don’t think about configuring it. Interested friends can try it.

The above is the entire content of this article. I hope it will be helpful to everyone's study. For more related content, please pay attention to the PHP Chinese website!

Related recommendations:

How to solve the problem of incorrect access path after Vue background image is packaged

Based on casperjs and resemble .js implements a pixel comparison service

Introduction to initializing the stylus installation method for the first time after the vue project is created

The above is the detailed content of Introduction to the configuration of using Typescript in Vue2 Vue-cli. For more information, please follow other related articles on the PHP Chinese website!