vue-property-decorator

在Vue中使用Typescript,通过vue-property-decorator装饰器库来简化书写。
vue-property-decorator依赖vue-class-component

  • @Component (from vue-class-component)
  • @Emit
  • @Prop
  • @PropSync
  • @Watch
  • @Inject
  • @Provide
  • @Model
  • @Ref
  • Mixins(from vue-class-component)

@Component 声明组件

import { Vue,Component } from 'vue-property-decorator'
import {componentA} from '@/components'
@Component({
    components: {componentA} // 其他组件声明
})
// @Component
export default class '组件名' extends Vue {
    private valueA: string = '....'  // data里的变量
    private valueB: number[] = [1,2,3]
    private get valueC () {  // 计算属性
        return 1
    }
    public render() {
        return (<div>...</div>)
    }
}

@Emit 事件触发

  // 子组件
  @Emit() // 参数为父组件绑定事件名,不写默认跟随的函数名称[这种情况下,camelCase名称将转换为kebab-case]
  private emitChange() {
     return 'something' // 如果想返回值,可以这边return 
  }

  @Emit('reset') 
  private emitChange1() {
     return 'something' // 如果想返回值,可以这边return 
  }

  // 父组件
  <child onReset={(res: any) => this.parentHandleChange(res)}>

@Watch 值变化监听

private value: string = 'tt'
@Watch('value')
private valueWatch(newval: string, old: string) {}

@Watch('person', {immediate: true, deep: true})
private valueWatch(newval: Person, old: Person) {}

❣ watch方法需要声明在变量和jsx后

Prop 父组件传递数据

  // child.tsx
  @Prop()
   public msg:string;
  @Prop(Number) prop1!: number;
  @Prop({
    type: String,
    default: 'default value',  // 一般为String, Number
    // 对象|数组,则默认值从函数返回
    // default: ()=>{ return [1,2] }
    required: false,
    validator: (value) => {
        return [1,2].indexOf(value) !== -1
    }
  }) prop2!: string;
  @Prop([string, Boolean]) prop3: string | boolean;

🎈 !必定有值 ?可传参数

@PropSync

@PropSync(propName: string, options: (propOptions | Constructor[] | Constructor) = {})

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

  @Component
  export default class YourComponent extends Vue {
    @PropSync('name', { type: String }) syncedName!: string
  }

等同于

export default {
  props: {
    name: {
      type: String
    }
  },
  computed: {
    syncedName: {
      get() {
        return this.name
      },
      set(value) {
        this.$emit('update:name', value)
      }
    }
  }
}

//父組件.js
// 我们在使用@PropSync装饰器的时候,计算属性set方法抛出的事件名让我们无法直接以onEventName的形式书写
on={['update:name']: this.handle}

mixins

  // mixins.ts
  export default class MyMixins extends Vue{
    value: string ='hi'
  }
  // 引入
  // 法一  vue-class-component提供
  import {mixins} from 'vue-class-component'
  import myMixins from 'mixin.ts'
@Componnet
  export default class myCom extends mixins(myMixins){
      public create () {
        console.log(this.value)
      }
  }

  // 法2 @Component中混入
  // mixins.ts
  declare module 'vue/types/vue' {
      interface Vue {
        value: string
    }
  }
  @Component
  export default class myMixins extends Vue {
    value: string = 'hello'
  }
 // 引入
  @Component({
    mixins: [myMixins]
  })
export default class myCom extends mixins(myMixins){
     public create () {
        console.log(this.value)
      }
  }

@Model

vue组件提供model:{prop?:string, event?:string}让我们可以定制propevent,默认情况下,一个组件上的v-model会把value用作prop,把input用作 event,但是一些组件比如单选框和复选框可能想使用value prop来达到不同的目的,可以使用model选项回避冲突

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

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

@Model()接收两个参数, 第一个是event值, 第二个是prop的类型说明, 与@Prop类似; 【🎈这里的类型要用JS的. 后面在接着是prop和在TS下的类型说明.】

Vue.component('my-checkbox', {
  model: {
    prop: 'checked',
    event: 'change'
  },
  props: {
    // this allows using the `value` prop for a different purpose
    value: String,
    // use `checked` as the prop which take the place of `value`
    checked: {
      type: Number,
      default: 0
    }
  },
  // ...
})
<my-checkbox v-model="foo" value="some value"></my-checkbox>

等同于

<my-checkbox
  :checked="foo"
  @change="val => { foo = val }"
  value="some value">
</my-checkbox>

即foo双向绑定的是组件的checked, 触发双向绑定数值的事件是change

@Provide提供/@Inject注入

父组件不便于向子组件传递数据,就把数据通过provide传递下去,然后子组件通过Inject来获取

 // js写法
  data() {return {foo: 'foo'}}
  provide() {
    return { foo, this.foo}
  }
  inject: {
    
  }

  // ts
  import {Vue,Component,Inject,Provide} from 'vue-property-decorator'
@Component
export defalut class MyComponent extends Vue{ 
  @Inject()
  foo!: string
  @Inject('bar')
  bar!: string
  @Inject({ from:'optional', default:'default'})
  optional!: string;

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

@Ref

(refKey?: string) decorator

import { Vue, Component, Ref } from 'vue-property-decorator'
 
import AnotherComponent from '@/path/to/another-component.vue'
 
@Component
export default class YourComponent extends Vue {
  @Ref() readonly anotherComponent!: AnotherComponent
  @Ref('aButton') readonly button!: HTMLButtonElement
}

等同于

export default {
  computed() {
    anotherComponent: {
      cache: false,
      get() {
        return this.$refs.anotherComponent as AnotherComponent
      }
    },
    button: {
      cache: false,
      get() {
        return this.$refs.aButton as HTMLButtonElement
      }
    }
  }
}

https://www.npmjs.com/package/vue-property-decorator

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,335评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,895评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,766评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,918评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,042评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,169评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,219评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,976评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,393评论 1 304
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,711评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,876评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,562评论 4 336
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,193评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,903评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,142评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,699评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,764评论 2 351

推荐阅读更多精彩内容