vue .sync修饰符的使用

Posted wuyuchao

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了vue .sync修饰符的使用相关的知识，希望对你有一定的参考价值。

vue的官网介绍非常不错，先通读一遍。

2.3.0+ 新增

在有些情况下，我们可能需要对一个 prop 进行“双向绑定”。不幸的是，真正的双向绑定会带来维护上的问题，因为子组件可以修改父组件，且在父组件和子组件都没有明显的改动来源。

这也是为什么我们推荐以 update:my-prop-name 的模式触发事件取而代之。举个例子，在一个包含 title prop 的假设的组件中，我们可以用以下方法表达对其赋新值的意图：

this.$emit(‘update:title‘, newTitle)

然后父组件可以监听那个事件并根据需要更新一个本地的数据属性。例如：

<text-document
  v-bind:title="doc.title"
  v-on:update:title="doc.title = $event"
></text-document>

为了方便起见，我们为这种模式提供一个缩写，即 .sync 修饰符：

<text-document v-bind:title.sync="doc.title"></text-document>

当我们用一个对象同时设置多个 prop 的时候，也可以将这个 .sync 修饰符和 v-bind 配合使用：

<text-document v-bind.sync="doc"></text-document>

这样会把 doc 对象中的每一个属性 (如 title) 都作为一个独立的 prop 传进去，然后各自添加用于更新的 v-on 监听器。

以下为代码实例

father.vue

<template>
  <div class="hello">

    //input实时改变wrd的值, 并且会实时改变box里的内容
    <input type="text" v-model="wrd">

    <box :word.sync="wrd" ></box>

  </div>
</template>

<script>
import box from ‘./box‘  //引入box子组件
export default {
  name: ‘HelloWorld‘,
  data() {
    return {
      wrd: ‘‘
    }
  },
  components: {
    box
  }  
}
</script>

child.vue

<template>
  <div class="hello">
    <div class="ipt">
      <input type="text" v-model="str">
    </div>

    //word是父元素传过来的
    <h2>{{ word }}</h2>

  </div>
</template>

<script>
export default {
  name: ‘box‘,
  data() {
    return {
      str: ‘‘,
    }
  },
  props: {
    word: ‘‘
  },
  watch: {
    str: function(newValue, oldValue) {
      //每当str的值改变则发送事件update:word , 并且把值传过去
      this.$emit(‘update:word‘, newValue)
    }
  }
}
</script>

那这个修饰符的原理是什么呢？其实还是vue父组件可以监听子组件的事件，自组件可以触发父组件的事件

father.vue

<template>
  <div class="hello">

    <input type="text" v-model="wrd">

    <box @incre="boxIncremend" ></box>


  </div>
</template>

<script>
import box from ‘./box‘
export default {
  name: ‘HelloWorld‘,
  data() {
    return {
      wrd: ‘‘
    }
  },
  methods: {
    boxIncremend(e) {
      this.wrd = this.wrd + e
    }
  },
  components: {
    box
  }
}
</script>

child.vue

<template>
  <div class="hello">

      <input type="text" v-model="str">

    <h2>{{ word }}</h2>

  </div>
</template>

<script>
export default {
  name: ‘box‘,
  data() {
    return {
      num: 0
    }
  },
  props: {
    word: ‘‘
  },
  watch: {
    str: function(neww, old) {
      //往父级发射incre事件
      this.$emit(‘incre‘, ++this.num)

    }
  },

}
</script>

在没有sync的时候，我们要实现双向绑定，可能需要在父组件里绑定一个事件和一个值

father.vue

<template>
  <div class="hello">

    <input type="text" v-model="wrd">

    <box @incre="boxIncremend" :word="word"></box>


  </div>
</template>

<script>
import box from ‘./box‘
export default {
  name: ‘HelloWorld‘,
  data() {
    return {
      word: ‘‘
    }
  },
  methods: {
    boxIncremend(newword) {
      this.word = newword
    }
  },
  components: {
    box
  }
}
</script>

child.vue

<template>
  <div class="hello">

      <input type="text" v-model="str">

    <h2>{{ word }}</h2>

  </div>
</template>

<script>
export default {
  name: ‘box‘,
  props: {
    word: ‘‘
  },
  watch: {
    str: function(newword) {
      //往父级发射incre事件
      this.$emit(‘incre‘, newword)

    }
  },

}
</script>

但是有了sync之后，我们就可以这么写

father.vue

<template>
  <div class="hello">

    <input type="text" v-model="wrd">

    <box :wrd.sync="wrd"></box>


  </div>
</template>

<script>
import box from ‘./box‘
export default {
  name: ‘HelloWorld‘,
  data() {
    return {
      wrd: ‘‘
    }
  },
  methods: {
    boxIncremend(e) {
      this.wrd = e
    }
  },
  components: {
    box
  }
}
</script>

child.vue

<template>
  <div class="hello">

      <input type="text" v-model="str">

    <h2>{{ word }}</h2>

  </div>
</template>

<script>
export default {
  name: ‘box‘,
  props: {
    word: ‘‘
  },
  watch: {
    str: function(newword) {
      //往父级发射incre事件
      this.$emit(‘update:word‘, newword)

    }
  },

}
</script>

父组件中的子组件，少写了一个自定义事件属性，子组件中$emit直接出发父组件中数据的更新，清新明了。使用中需要注意的是，update和后面对应的数据名不能写错。

父子组件的双向数据绑定

  • 父组件改变数据可以改变子组件, 但是子组件的内容改变并不会影响到父组件
  • 可以通过2.3.0新增的sync修饰符来达到双向绑定的效果

father.vue

<template>
  <div class="hello">

    //input实时改变wrd的值, 并且会实时改变box里的内容
    <input type="text" v-model="wrd">

    <box :word.sync="wrd" ></box>

  </div>
</template>

<script>
import box from ‘./box‘  //引入box子组件
export default {
  name: ‘HelloWorld‘,
  data() {
    return {
      wrd: ‘‘
    }
  },
  components: {
    box
  }  
}
</script>

<style scoped></style>
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30

box.vue

<template>
  <div class="hello">
    <div class="ipt">
      <input type="text" v-model="str">
    </div>

    //word是父元素传过来的
    <h2>{{ word }}</h2>

  </div>
</template>

<script>
export default {
  name: ‘box‘,
  data() {
    return {
      str: ‘‘,
    }
  },
  props: {
    word: ‘‘
  },
  watch: {
    str: function(newValue, oldValue) {
      //每当str的值改变则发送事件update:word , 并且把值传过去
      this.$emit(‘update:word‘, newValue)
    }
  }
}
</script>

<style scoped></style>
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36

原理

  • 利用了父级可以在子元素上监听子元素的事件 
    father.vue
<template>
  <div class="hello">

    <input type="text" v-model="wrd">

    <box @incre="boxIncremend" ></box>


  </div>
</template>

<script>
import box from ‘./box‘
export default {
  name: ‘HelloWorld‘,
  data() {
    return {
      wrd: ‘‘
    }
  },
  methods: {
    boxIncremend(e) {
      this.wrd = this.wrd + e
    }
  },
  components: {
    box
  }
}
</script>

<style scoped></style>
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35

box.vue

<template>
  <div class="hello">

      <input type="text" v-model="str">

    <h2>{{ word }}</h2>

  </div>
</template>

<script>
export default {
  name: ‘box‘,
  data() {
    return {
      num: 0
    }
  },
  props: {
    word: ‘‘
  },
  watch: {
    str: function(neww, old) {
      //往父级发射incre事件
      this.$emit(‘incre‘, ++this.num)

    }
  },

}
</script>

<style scoped></style>




以上是关于vue .sync修饰符的使用的主要内容，如果未能解决你的问题，请参考以下文章

Vue2 .sync修饰符的应用

vue .sync修饰符的使用

vue组件双向绑定.sync修饰符的一个坑

Vue 中的 .sync 修饰符有啥用

前端vue中的v-model与.sync修饰符的区别

前端vue中的v-model与.sync修饰符的区别