Vue 自定义组件中 v-model 与 .sync 修饰符的使用详解

作者:雾松时间:2026-10-25 16:57:03浏览:457

本文详解Vue自定义组件中v-model与.sync修饰符的使用。v-model默认绑定value属性和input事件,通过$emit触发更新;.sync语法糖简化了多个属性的同步,默认生成update:xxx事件。两者均为语法糖,旨在减少样板代码,提升开发效率。

自定义事件

提示

  • 推荐始终使用 kebab-case 的事件名。(v-on会将事件名自动转换为小写,避免匹配不到)
    • 建议始终使用短横线命名法(kebab-case)来定义事件名。因为v-on监听器会自动将事件名转换为小写,使用短横线命名可以避免因大小写不匹配而导致的事件监听失效。
    • 例如,避免使用驼峰命名如changeData,而应使用change-data。

自定义组件的v-model

  • 用法:
    • 在父组件中,只需定义数据源,无需手动编写修改数据的方法。在子组件标签上,通过v-model="data"的形式将数据传递给子组件。
    • 默认情况下,v-model传递的属性名为value,触发的事件名为input。如果在子组件中配置了model选项,则可以自定义属性名和事件名,从而重命名默认的绑定行为。
    • 在子组件中,props必须接收名为value的属性(这是固定名称)。为了修改数据并实现双向绑定,子组件需要通过$emit("input", payload)来触发input事件,将新值传递给父组件。
    // 父组件
    <template>
    <div>
        <p>我是dad</p>
        <span>{{ dadData }}</span>
        <Son v-model="dadData" />
    </div>
    </template>

    <script>
        import Son from "./SonItem.vue";

        export default {
            components: {
                Son,
            },
            data() {
                return {
                dadData: "我是爹地",
                };
            },
        };
    </script>

    // 子组件
    <template>
        <div>
            <p>我是儿子组件</p>
            <input type="text" :value="value" @input="sonInput" />
            <button @click="btnClick(Date.now())">点击</button>
        </div>
    </template>

    <script>
        export default {
            // 如果重命名,记得这里也要修改哦 props: ["novalue]
            props: ["value"],
            // 这里可以重命名接收到的属性值和事件名
            // model: {
            //   prop: "novalue",
            //   event: "changeNoval",
            // },
            methods: {
                sonInput(e) {
                    this.$emit(`input`, e.target.value);
                },
                btnClick(data) {
                    this.$emit(`input`, data);
                },
            },
        };
    </script>

.sync 修饰符

  • 为什么需要这个修饰符?它解决了什么问题?

    • 在传统的父子组件通信中,父组件通过props传递参数,并通过v-on监听子组件触发的事件来更新数据。子组件通过$emit方法触发事件通知父组件。
    • 如果父组件需要处理多个属性的同步,每次都要定义类似this.data = newData的事件处理函数。如果传递的是一个对象,其每个属性都需要单独定义相应的事件函数,这会导致大量重复且繁琐的代码。
    • .sync修饰符正是为了解决上述代码冗余问题而设计的,它简化了多个属性同步更新的写法。
  • 如何使用.sync?

    • 在父组件中,可以直接在子组件标签上使用:name.sync="person.name"的语法来绑定属性。
    • 默认情况下,.sync会生成一个处理事件名为update:name的事件,其中name即为传递过去的属性名。
    • 在子组件中,如果需要访问这些属性,可以通过props接收,也可以利用$attr,$parent等机制获取。需要注意的是,已经通过props接收过的属性不会出现在当前实例的$attrs中。
    • 当需要触发更新事件时,可以使用$emit("update:属性名", payload)的方式,或者利用$listener来获取监听器。
    • 此外,使用v-bind.sync="obj"可以将对象中的每个属性和对应的事件自动分发给子组件,进一步简化代码。
// 父组件
<template>
  <div>
    <p>我是dad</p>
    <span>{{ dadData }}</span>
    <Son :something.sync="dadData" v-bind.sync="dadObj" />
  </div>
</template>

<script>
import Son from "./SonItem.vue";

export default {
  components: {
    Son,
  },
  data() {
    return {
      dadData: "我是爹地",
      dadObj: {
        girlFriends: ["dingding", "momo", "weiwei"],
        age: 24,
      },
    };
  },
};
</script>


// 子组件
<template>
  <div>
    <p>我是儿子组件</p>
    <button @click="btnClick(Date.now())">点击</button>
    <span>{{ something }}</span>
    <span>{{ girlFriends }}</span>
  </div>
</template>

<script>
export default {
  props: ["something", "girlFriends"],
  methods: {
    btnClick(data) {
      this.$emit(`update:something`, data);
    },
  },
  mounted() {
    this.$listeners["update:girlFriends"](["singleDog"]);
    // {age: 24}
    console.log(this.$attrs);
  },
};
</script>

思考

v-model和.sync本质上都是语法糖,它们的设计初衷是为了方便使用并减少代码量。然而,关于这种更利于封装的机制究竟是降低了新手的上手难度,还是增加了学习负担,社区中可能各执己见。

本文仅为个人学习文档及总结,具体细节请自行查阅官方文档以获取准确信息。

参考链接:https://cn.vuejs.org/v2/guide/components-custom-events.html

总结

到此这篇关于vue在自定义组件上使用v-model和.sync的文章就介绍到这了,更多相关vue自定义组件使用v-model和.sync内容请搜索本站以前的文章或继续浏览下面的相关文章希望大家以后多多支持本站!

作者最新文章