vue-class-decorator v7.6.3

Vue Class Decorator

This library is modified base on vue-property-decorator

& Fully depends on vue-class-component, so please read its README before using this library.

License

MIT License

Install

npm i -S vue-class-decorator

Usage

There are 7 decorators and 1 function (Mixin):

• @FunctionalVue
• @Filter
• @On
• @Once
• @Mounted
• @Cache
• @NoCache
• @Emit (from vue-property-decorator)
• @Inject (from vue-property-decorator)
• @Model (from vue-property-decorator)
• @Prop (from vue-property-decorator)
• @Provide (from vue-property-decorator)
• @Watch (from vue-property-decorator)
• @Component (from vue-class-component)
• Mixins (the helper function named mixins defined at vue-class-component)

Note: all the lifecycle hooks are supported

FunctionalVue class

import { FunctionalVue, Component, Filter } from 'vue-class-decorator'

@Component
export default class YourComponent extends FunctionalVue {
  //...
}

is equivalent to

export default {
  functional: true
  //...
}

@Filter(name?: string) decorator

import { Vue, Component, Filter } from 'vue-class-decorator'

@Component
export default class YourComponent extends Vue {
  @Filter('date')
  DateFilter(val: string) { }

  @Filter()
  date2(val: string) { }
}

is equivalent to

export default {
  filter: {
    date(val) {},
    date2(val) {}
  }
}

@On(event?: string, reserve: boolean = true) decorator

NOTE: set reserve to false will delete method from vue instance

import { Vue, Component, On } from 'vue-class-decorator'

@Component
export default class YourComponent extends Vue {
  @On("change")
  Handler(e) { 
    //handler1
  }

  @On()
  InputEvent(e) { 
    //handler2
  }

  @On("resize", false)
  Handler2(e) { 
    //handler3
  }
}

is equivalent to

export default {
  methods: {
    Handler(e) { 
      //handler1
    },
    InputEvent(e) { 
      //handler2
    }
  },
  mounted() {
    this.$on("change", this.Handler)

    this.$on("input-event", this.InputEvent)

    this.$on("resize", () => {
      //handler3
    })
  }
}

@Once(event?: string, reserve: boolean = true) decorator

NOTE: set reserve to false will delete method from vue instance

import { Vue, Component, Once } from 'vue-class-decorator'

@Component
export default class YourComponent extends Vue {
  @Once("change")
  Handler(e) { 
    //handler1
  }

  @Once()
  InputEvent(e) { 
    //handler2
  }

  @Once("resize", false)
  Handler2(e) { 
    //handler3
  }
}

is equivalent to

export default {
  methods: {
    Handler(e) { 
      //handler1
    },
    InputEvent(e) { 
      //handler2
    }
  },
  mounted() {
    this.$once("change", this.Handler)

    this.$once("input-event", this.InputEvent)

    this.$once("resize", () => {
      //handler3
    })
  }
}

@Mounted(order?: number, args?: any[]) decorator

@Mounted(args?: any[]) decorator

The other lifecycle hooks are same

import { Vue, Component, Mounted } from 'vue-class-decorator'

@Component
export default class YourComponent extends Vue {
  @Mounted()
  Method1() { 
  }

  @Mounted(2, ["test"])
  Method2(a: string) {
  }

  @Mounted(1)
  Method3() { 
  }

  @Mounted(["test"])
  Method4(a: string) { 
  }
}

is equivalent to

export default {
  methods: {
    Method1() { 
    }
    Method2(a) { 
    }
    Method3() { 
    }
    Method4(a) { 
    }
  },
  mounted() {
    this.Method3();
    this.Method2("test");
    this.Method1();
    this.Method4("test");
    //...
  }
}

@Cache(cache: boolean) decorator

import { Vue, Component, Cache } from 'vue-class-decorator'

@Component
export default class YourComponent extends Vue {
  @Cache()
  get random () {
    return Math.random()
  }

  // the computed property will not be cached
  @Cache(false)
  get random2 () {
    return Math.random()
  }
}

@NoCache decorator

This is the alias for @Cache(false)

import { Vue, Component, NoCache } from 'vue-class-decorator'

@Component
export default class YourComponent extends Vue {
  // the computed property will not be cached
  @NoCache
  get random () {
    return Math.random()
  }
}

@Prop(options: (PropOptions | Constructor[] | Constructor) = {}) decorator

import { Vue, Component, Prop } from 'vue-class-decorator'

@Component
export default class YourComponent extends Vue {
  @Prop(Number) propA!: number
  @Prop({ default: 'default value' }) propB!: string
  @Prop([String, Boolean]) propC: string | boolean
}

is equivalent to

export default {
  props: {
    propA: {
      type: Number
    },
    propB: {
      default: 'default value'
    },
    propC: {
      type: [String, Boolean]
    },
  }
}

Note that:

• reflect-metada isn't used in this library and setting emitDecoratorMetadata to true means nothing.
• Each prop's default value need to be defined as same as the example code shown in above.

@Model(event?: string, options: (PropOptions | Constructor[] | Constructor) = {}) decorator

import { Vue, Component, Model } from 'vue-class-decorator'

@Component
export default class YourComponent extends Vue {
  @Model('change', { type: Boolean }) checked!: boolean
}

is equivalent to

export default {
  model: {
    prop: 'checked',
    event: 'change'
  },
  props: {
    checked: {
      type: Boolean
    },
  },
}

@Watch(path: string, options: WatchOptions = {}) decorator

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

@Component
export default class YourComponent extends Vue {
  @Watch('child')
  onChildChanged(val: string, oldVal: string) { }

  @Watch('person', { immediate: true, deep: true })
  onPersonChanged(val: Person, oldVal: Person) { }
}

is equivalent to

export default {
  watch: {
    'child': {
      handler: 'onChildChanged',
      immediate: false,
      deep: false
    },
    'person': {
      handler: 'onPersonChanged',
      immediate: true,
      deep: true
    }
  },
  methods: {
    onChildChanged(val, oldVal) { },
    onPersonChanged(val, oldVal) { }
  }
}

@Emit(event?: string) decorator

The functions decorated by @Emit $emit their return value followed by their original arguments. If the return value is a promise, it is resolved before being emitted.

If the name of the event is not supplied via the event argument, the function name is used instead. In that case, the camelCase name will be converted to kebab-case.

import { Vue, Component, Emit } from 'vue-class-decorator'

@Component
export default class YourComponent extends Vue {
  count = 0

  @Emit()
  addToCount(n: number) {
    this.count += n
  }

  @Emit('reset')
  resetCount() {
    this.count = 0
  }

  @Emit()
  returnValue() {
    return 10
  }

  @Emit()
  promise() {
    return new Promise(resolve => {
      setTimeout(() => {
        resolve(20)
      }, 0)
    })
  }
}

is equivalent to

export default {
  data() {
    return {
      count: 0
    }
  },
  methods: {
    addToCount(n) {
      this.count += n
      this.$emit('add-to-count', n)
    },
    resetCount() {
      this.count = 0
      this.$emit('reset')
    },
    returnValue() {
      this.$emit('return-value', 10)
    },
    promise() {
      const promise = new Promise(resolve => {
        setTimeout(() => {
          resolve(20)
        }, 0)
      })

      promise.then(value => {
        this.$emit('promise', value)
      })
    }
  }
}

@Provide(key?: string | symbol) / @Inject(options?: { from?: InjectKey, default?: any } | InjectKey) decorator

import { Component, Inject, Provide, Vue } from 'vue-class-decorator'

const symbol = Symbol('baz')

@Component
export class MyComponent extends Vue {
  @Inject() foo!: string
  @Inject('bar') bar!: string
  @Inject({ from: 'optional', default: 'default' }) optional!: string
  @Inject(symbol) baz!: string


  @Provide() foo = 'foo'
  @Provide('bar') baz = 'bar'
}

is equivalent to

const symbol = Symbol('baz')

export const MyComponent = Vue.extend({

  inject: {
    foo: 'foo',
    bar: 'bar',
    'optional': { from: 'optional', default: 'default' },
    [symbol]: symbol
  },
  data () {
    return {
      foo: 'foo',
      baz: 'bar'
    }
  },
  provide () {
    return {
      foo: this.foo,
      bar: this.baz
    }
  }
})

See also

vuex-class