node package manager
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

vue-property-decorator

Vue Property Decorator

npm

This library fully depends on vue-class-component.

License

MIT License

Install

npm i -S vue-property-decorator

Usage

There are 7 decorators:

  • @Emit
  • @Inject
  • @Model
  • @Prop
  • @Provide
  • @Watch
  • @Component (exported from vue-class-component)
import { Component, Emit, Inject, Model, Prop, Provide, Vue, Watch } from 'vue-property-decorator'
 
const s = Symbol('baz')
 
@Component
export class MyComponent extends Vue {
 
  @Emit()
  addToCount(n: number){ this.count += n }
 
  @Emit('reset')
  resetCount(){ this.count = 0 }
 
  @Inject() foo: string
  @Inject('bar') bar: string
  @Inject(s) baz: string
 
  @Model('change') checked: boolean
 
  @Prop()
  propA: number
 
  @Prop({ default: 'default value' })
  propB: string
 
  @Prop([String, Boolean])
  propC: string | boolean
 
  @Provide() foo = 'foo'
  @Provide('bar') baz = 'bar'
 
  @Watch('child')
  onChildChanged(val: string, oldVal: string) { }
 
  @Watch('person', { immediate: true, deep: true })
  onPersonChanged(val: Person, oldVal: Person) { }
}
 

is equivalent to

const s = Symbol('baz')
 
export const MyComponent = Vue.extend({
  name: 'MyComponent',
  inject: {
    foo: 'foo',
    bar: 'bar',
    [s]: s
  },
  model: {
    prop: 'checked',
    event: 'change'
  },
  props: {
    checked: Boolean,
    propA: Number,
    propB: {
      type: String,
      default: 'default value'
    },
    propC: [String, Boolean],
  },
  data () {
    return {
      foo: 'foo',
      baz: 'bar'
    }
  },
  provide () {
    return {
      foo: this.foo,
      bar: this.baz
    }
  },
  methods: {
    addToCount(n){
      this.count += n
      this.$emit("add-to-count", n)
    },
    resetCount(){
      this.count = 0
      this.$emit("reset")
    },
    onChildChanged(val, oldVal) { },
    onPersonChanged(val, oldVal) { }
  },
  watch: {
    'child': {
      handler: 'onChildChanged',
      immediate: false,
      deep: false
    },
    'person': {
      handler: 'onPersonChanged',
      immediate: true,
      deep: true
    }
  }
})

emitDecoratorMetadata

As you can see at propA and propB, the type can be inferred automatically when it's a simple type. For more complex types like enums you do need to specify it specifically. Also this library needs to have emitDecoratorMetadata set to true for this to work.

See also

vuex-class