Vue3 SFC 和 TSX 方式自定义组件实现 v-model的详细过程

更新时间：2022年10月21日 14:56:54 作者：程序员优雅哥（\/同）

v-model 是 vue3 中的一个内置指令，很多表单元素都可以使用这个属性，如 input、checkbox 等，咱可以在自定义组件中实现 v-model，这篇文章主要介绍了Vue3 SFC 和 TSX 方式自定义组件实现 v-model,需要的朋友可以参考下

1 v-model

1.1 理解 v-model

v-model 是 vue3 中的一个内置指令，很多表单元素都可以使用这个属性，如 input、checkbox 等，咱可以在自定义组件中实现 v-model。v-model 本质上是一个语法糖：

绑定父组件传递过来的 modelValue 属性；
值改变时向父组件发出事件 update:modelValue。

1.2 案例描述

理解了 v-model 的本质，咱可以分别使用 SFC（.vue 文件）和 TSX（.tsx）方式定义一个组件 person-name ，使该组件可以使用 v-model。

person-name 包括两个输入框，分别是“姓”（familyName）和“名”（firstName）两个字段，v-model 传递的数据格式为：

{ familyName: '张', firstName: '三' }

首先定义该类型 person-name-type.ts：

export interface PersonName {
  /** 姓 */
  familyName?: string;
  /** 名 */
  firstName?: string;
}

1.3 编写样式

编写 person-name.scss 样式文件，后面再两个组件中分别引入：

.person-name {
  .el-form-item {
    width: 200px;
  }
}

2 编写组件

2.1 实现思路

person-name 组件实现逻辑比较简单：

template 中放置两个输入框 el-input，分别对应姓和名两个字段；
定义两个变量 innerFamilyName 和 innerFirstName 绑定两个输入框的值；
在 props 定义 modeValue 属性，接收父组件传递过来的 PersonName 类型的对象；
使用 watch 深度监听 modelValue，当其属性值有变化时，重新赋值给上面绑定输入框的两个变量；
当两个输入框触发 input 事件时，通过 update:modelValue 事件通知父组件，从而实现 v-model。

2.2 SFC（.vue）中的实现

创建组件文件 person-name-sfc.vue：

<template>
  <div class="person-name">
    <el-form-item label="姓">
      <el-input v-model="innerFamilyName" @input="onInput"></el-input>
    </el-form-item>
    <el-form-item label="名">
      <el-input v-model="innerFirstName" @input="onInput"></el-input>
    </el-form-item>
  </div>
</template>

<script lang="ts" setup name="person-name-sfc">
import { PropType, ref, watch } from 'vue'
import { PersonName } from './person-name-type'

const props = defineProps({
  modelValue: {
    type: Object as PropType<PersonName>,
    required: true,
    default: () => ({})
  }
})

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

const innerFamilyName = ref('')
const innerFirstName = ref('')

watch(() => props.modelValue, (newVal) => {
  innerFamilyName.value = newVal?.familyName || ''
  innerFirstName.value = newVal?.firstName || ''
}, {
  deep: true,
  immediate: true
})

const onInput = () => {
  emits('update:modelValue', {
    familyName: innerFamilyName.value,
    firstName: innerFirstName.value
  })
}
</script>

<style scoped lang="scss">
@import "./person-name";
</style>

2.3 TSX（.tsx）中的实现

创建组件文件 person-name-tsx.tsx：

import { defineComponent, PropType, ref, watch } from 'vue'
import { PersonName } from './person-name-type'
import './person-name.scss'

export default defineComponent({
  name: 'person-name-tsx',
  props: {
    modelValue: {
      type: Object as PropType<PersonName>,
      required: true,
      default: () => ({})
    }
  },
  emits: ['update:modelValue'],
  setup (props, context) {
    const innerFamilyName = ref(props.modelValue.familyName)
    const innerFirstName = ref(props.modelValue.firstName)

    const onInput = () => {
      context.emit('update:modelValue', {
        familyName: innerFamilyName.value,
        firstName: innerFirstName.value
      })
    }

    watch(() => props.modelValue, (newVal) => {
      innerFamilyName.value = newVal?.familyName || ''
      innerFirstName.value = newVal?.firstName || ''
    }, {
      deep: true,
      immediate: true
    })

    return () => (
      <div class="person-name">
        <el-form-item label="姓">
          <el-input vModel={innerFamilyName.value} onInput={onInput}/>
        </el-form-item>
        <el-form-item label="名">
          <el-input vModel={innerFirstName.value} onInput={onInput}/>
        </el-form-item>
      </div>
    )
  }
})

3 使用组件

创建父组件 demo-v-model.vue，在里面使用上面定义的两个组件：

<template>
  <div>
    <person-name-sfc v-model="personName1"></person-name-sfc>
    <el-button @click="onResetClick1">reset</el-button>
    <div>{{personName1}}</div>
  </div>
  <el-divider />
  <div>
    <person-name-tsx v-model="personName2"></person-name-tsx>
    <el-button @click="onResetClick2">reset</el-button>
    <div>{{personName2}}</div>
  </div>
</template>

<script lang="ts" setup>
import PersonNameSfc from '@/components/model/person-name-sfc.vue'
import { ref } from 'vue'
import { PersonName } from '@/components/model/person-name-type'
import PersonNameTsx from '@/components/model/person-name-tsx'

const defaultPersonName = { familyName: '张', firstName: '三' }

const personName1 = ref<PersonName>({ ...defaultPersonName })
const personName2 = ref<PersonName>({ ...defaultPersonName })

const onResetClick1 = () => {
  personName1.value = { ...defaultPersonName }
}
const onResetClick2 = () => {
  personName2.value = { ...defaultPersonName }
}
</script>

运行效果如下：

上面部分使用 .vue 编写的组件，下面部分使用 .tsx 编写的组件，两者独立绑定 v-model，运行效果完全一致。

子组件可以接收到父组件传递的初始值；
子组件值改变时会通知到父组件；
父组件改变值时，子组件会响应变更。

到此这篇关于Vue3 SFC 和 TSX 方式自定义组件实现 v-model的文章就介绍到这了,更多相关Vue3 自定义组件v-model内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

使用Vue CLI配置代码压缩、加密和混淆功能示例代码
这篇文章主要介绍了使用Vue CLI配置代码压缩、加密和混淆功能,通过配置 vue.config.js 文件，我们可以使用 Vue CLI 轻松实现对 Vue 应用程序代码的压缩、加密和混淆，需要的朋友可以参考下
2023-06-06
基于vue的tab-list类目切换商品列表组件的示例代码
这篇文章主要介绍了基于vue的tab-list类目切换商品列表组件的示例代码，代码简单易懂，非常不错，具有一定的参考借鉴价值,需要的朋友可以参考下
2020-02-02
浅谈Vue页面级缓存解决方案feb-alive (下)
这篇文章主要介绍了浅谈Vue页面级缓存解决方案feb-alive(下),文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2019-04-04
Sublime Text新建.vue模板并高亮(图文教程)
这篇文章主要介绍了Sublime Text新建.vue模板并高亮(图文教程)，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-10-10
vue项目element-ui级联选择器el-cascader回显的问题及解决
这篇文章主要介绍了vue项目element-ui级联选择器el-cascader回显的问题及解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2023-07-07
vue 绑定使用 touchstart touchmove touchend解析
这篇文章主要介绍了vue 绑定使用 touchstart touchmove touchend解析，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-03-03
vue前端传空值、空字符串的问题及解决
这篇文章主要介绍了vue前端传空值、空字符串的问题及解决，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-06-06
Vue3中使用vant的踩坑实战日记
Vant是有赞前端团队开源的移动端组件库,于2017年开源,已持续维护4年时间,下面这篇文章主要给大家介绍了关于Vue3中使用vant的相关资料,文中通过图文介绍的非常详细,需要的朋友可以参考下
2022-10-10
八种vue实现组建通信的方式
这篇文章主要介绍是八种vue实现组建通信的方式，包括、props 父组件与子组件通信、$emit 子组件父组件传递、$emit与props结合兄弟组件传值等等，想具体了解的朋友可以参考下面文章的具体内容
2021-09-09
Vue中使用js-cookie详情
这篇文章主要介绍了Vue中使用js-cookie详情，文章围绕js-cookie的相关资料展开详细内容具有一定的的参考价值，需要的小伙伴可以参考一下
2022-03-03