vue3 双向绑定:如何在自定义组件中修改props定义的属性值,并更新父组件绑定的响应式变量值

1、自定义支持双向绑定的prop

在子组件中声明一个 count prop,通过触发 update:count 事件更新父组件值

子组件示例代码:

html 复制代码
<template>
    <div>
        <div>[子组件] count: {{ count }}</div>
        <button @click="onClick">+1</button>
    </div>
</template>

<script lang="ts">
import { defineComponent } from 'vue';
export default defineComponent({
    name: 'child-component',
    props: {
        count: {
            type: Number,
            default: 0
        }
    },
    emits: ['update:count'],
    setup(props, ctx) {
        const onClick = () => {
            ctx.emit('update:count', props.count + 1);
        }
        return {
            onClick
        };
    }
});
</script>

父组件示例代码:

html 复制代码
<template>
    <div>
        <div>[父组件] count: {{ count }}</div>
        <child-component :count="count" @update:count="count = $event"></child-component>
    </div>
</template>

<script lang="ts">
import ChildComponent from '@/components/child-component/child-component.vue';
import { defineComponent, ref } from 'vue';
export default defineComponent({
    components: { ChildComponent },
    setup() {
        return {
            count: ref<number>(0)
        };
    }
});
</script>

简化写法(语法糖),使用 v-model 双向数据绑定的指令

html 复制代码
<child-component v-model:count="count"></child-component>

2、子组件 prop 为 modelValue

在子组件中声明一个 modelValueprop,通过触发 update:modelValue 事件更新父组件值,父组件使用 v-model 、 v-model:modelValue 、 v-model:model-value 的写法都是支持的。

子组件示例代码:

TypeScript 复制代码
<script setup lang="ts">
  defineProps(['modelValue'])
</script>

<template>
  <el-input :modelValue="modelValue" @input="$emit('update:modelValue', $event)"/>
</template>

父组件示例代码:

TypeScript 复制代码
<script setup lang="ts">
import { ref } from 'vue'
import ChildComponent from './components/ChildComponent.vue'

const parentValue = ref('')
</script>

<template>
  <ChildComponent v-model="parentValue" />
</template>

其他支持写法:

TypeScript 复制代码
<ChildComponent v-model:modelValue="parentValue" />
<ChildComponent v-model:model-value="parentValue" />
<ChildComponent :modelValue="parentValue" @update:modelValue="parentValue = $event" />
<ChildComponent :model-value="parentValue" @update:model-value="parentValue = $event" />

3、子组件中也存在组件v-model 的值需与 prop 的值同步

定义一个可写的 computed 响应式变量,get直接返回传入子组件的 prop,set变更 prop 的值

TypeScript 复制代码
<script setup lang="ts">
  import { computed } from 'vue'

  const props = defineProps(['modelValue'])

  const emits = defineEmits(['update:modelValue'])

  const childValue = computed({
    get: () => props.modelValue,
    set: (val) => emits('update:modelValue', val)
  })
</script>

<template>
  <el-input v-model="childValue"/>
</template>

4、vue3.4+ 推荐使用 defineModel

写法更加简单,关于默认值、必填等选项配置可查阅文档

官方文档:https://cn.vuejs.org/api/sfc-script-setup.html#definemodel

子组件示例代码:

TypeScript 复制代码
<script setup lang="ts">
  const modelValue = defineModel()
</script>

<template>
  <el-input v-model="modelValue" />
</template>
相关推荐
excel9 小时前
为什么在 Three.js 中平面能产生“起伏效果”?
前端
excel10 小时前
Node.js 断言与测试框架示例对比
前端
天蓝色的鱼鱼12 小时前
前端开发者的组件设计之痛:为什么我的组件总是难以维护?
前端·react.js
codingandsleeping12 小时前
使用orval自动拉取swagger文档并生成ts接口
前端·javascript
石金龙13 小时前
[译] Composition in CSS
前端·css
白水清风13 小时前
微前端学习记录(qiankun、wujie、micro-app)
前端·javascript·前端工程化
Ticnix13 小时前
函数封装实现Echarts多表渲染/叠加渲染
前端·echarts
用户221520442780013 小时前
new、原型和原型链浅析
前端·javascript
阿星做前端13 小时前
coze源码解读: space develop 页面
前端·javascript
叫我小窝吧13 小时前
Promise 的使用
前端·javascript