正确使用defineModel

53 阅读1分钟

先来看看文档对defineModel的描述和使用例

<script setup>
const model = defineModel()

function update() {
  model.value++
}
</script>

<template>
  <div>Parent bound v-model is: {{ model }}</div>
  <button @click="update">Increment</button>
</template>
<Child v-model="countModel" />

image.png 不过这里的简单例子中 v-model的类型是数字类型 对它的变更自然也只有直接赋值这一种方式

那么 如果v-model是对象呢?

<script setup lang="ts">
const countObj = defineModel<{ count: number }>()
</script>
<template>
  <div class="m-4">
    {{ countObj.count }}
    <el-button
      @click="
        () => {
          countObj.count++
        }
      "
    >
      +1
    </el-button>
  </div>
</template>
<script setup lang="ts">
import { ref } from 'vue'
import Child from './Child.vue'

const countObj = ref({
  count: 1,
})
</script>
<template>
  <Child v-model="countObj" />
</template>

可以正常使用

动画.gif

v-model的value也是很正常的ref image.png

然而如果改一下写法

  <Child
    :model-value="countObj"
    @update:model-value="
      (val) => {
        debugger
        countObj = val
      }
    "
  />

就会发现@update:model-value根本没调用 这一点和文档是不一致的

如果countObj自身还是shallowRef(虽然一般也不会用) 那defineModel就会完全出错

image.png

这里的v-model甚至是一个完全没有响应性的变量 对它的变更不会触发渲染 也不会调用update事件

正确写法

直接对v-model的value属性整个赋值

<script setup lang="ts">
const countObj = defineModel<{ count: number }>()
</script>
<template>
  <div class="m-4">
    {{ countObj.count }}
    <el-button
      @click="
        () => {
          countObj = { count: countObj.count + 1 }
        }
      "
    >
      +1
    </el-button>
  </div>
</template>

这种写法会触发外部的@update事件 等效于emit('update:model-value')

直接改v-model的属性值 某些情况下是正常可用的 但实际是不规范的写法