Guide
Essentials
- Installation
- Introduction
- The Vue Instance
- Template Syntax
- Computed Properties and Watchers
- Class and Style Bindings
- Conditional Rendering
- List Rendering
- Event Handling
- Form Input Bindings
- Components Basics
Components In-Depth
- Component Registration
- Props
- Custom Events
- Slots
- Dynamic & Async Components
- Handling Edge Cases
Transitions & Animation
- Enter/Leave & List Transitions
- State Transitions
Reusability & Composition
- Mixins
- Custom Directives
- Render Functions & JSX
- Plugins
- Filters
Tooling
- Single File Components
- Testing
- TypeScript Support
- Production Deployment
Scaling Up
- Routing
- State Management
- Server-Side Rendering
- Security
Internals
- Reactivity in Depth
Migrating
- Migration from Vue 1.x
- Migration from Vue Router 0.7.x
- Migration from Vuex 0.6.x to 1.0
- Migration to Vue 2.7
Meta
- Comparison with Other Frameworks
- Join the Vue.js Community!
- Meet the Team
TypeScript Support
Vue CLI provides built-in TypeScript tooling support.
Official Declaration in NPM Packages
A static type system can help prevent many potential runtime errors, especially as applications grow. Thatâs why Vue ships with official type declarations for TypeScript - not only in Vue core, but also for vue-router and vuex as well.
Since these are published on NPM, and the latest TypeScript knows how to resolve type declarations in NPM packages, this means when installed via NPM, you donât need any additional tooling to use TypeScript with Vue.
Recommended Configuration
|
Note that you have to include strict: true
(or at least noImplicitThis: true
which is a part of strict
flag) to leverage type checking of this
in component methods otherwise it is always treated as any
type.
See TypeScript compiler options docs for more details.
Development Tooling
Project Creation
Vue CLI 3 can generate new projects that use TypeScript. To get started:
|
Editor Support
For developing Vue applications with TypeScript, we strongly recommend using Visual Studio Code, which provides great out-of-the-box support for TypeScript. If you are using single-file components (SFCs), get the awesome Vetur extension, which provides TypeScript inference inside SFCs and many other great features.
WebStorm also provides out-of-the-box support for both TypeScript and Vue.
Basic Usage
To let TypeScript properly infer types inside Vue component options, you need to define components with Vue.component
or Vue.extend
:
|
Class-Style Vue Components
If you prefer a class-based API when declaring components, you can use the officially maintained vue-class-component decorator:
|
Augmenting Types for Use with Plugins
Plugins may add to Vueâs global/instance properties and component options. In these cases, type declarations are needed to make plugins compile in TypeScript. Fortunately, thereâs a TypeScript feature to augment existing types called module augmentation.
For example, to declare an instance property $myProperty
with type string
:
|
After including the above code as a declaration file (like my-property.d.ts
) in your project, you can use $myProperty
on a Vue instance.
|
You can also declare additional global properties and component options:
|
The above declarations allow the following code to be compiled:
|
Annotating Return Types
Because of the circular nature of Vueâs declaration files, TypeScript may have difficulties inferring the types of certain methods. For this reason, you may need to annotate the return type on methods like render
and those in computed
.
|
If you find type inference or member completion isnât working, annotating certain methods may help address these problems. Using the --noImplicitAny
option will help find many of these unannotated methods.
Annotating Props
|
If you find validator not getting type inference or member completion isnât working, annotating the argument with the expected type may help address these problems.