资讯专栏INFORMATION COLUMN

详解Vue3 Composition API优雅封装第三方组件

3403771864 / 620人阅读

  我们时常会想在保持第三方组件原有功能(属性props、事件events、插槽slots、方法methods)的基础上,这些功能如何“优化”的实现?

  以Element Plus的el-input为例:

  在封装一个MyInput组件,把要使用的属性props、事件events和插槽slots、方法methods先要依照自己的需求来编写: 

 // MyInput.vue
  <template>
  <div class="my-input">
  <el-input v-model="inputVal" :clearable="clearable" @clear="clear">
  <template #prefix>
  <slot name="prefix"></slot>
  </template>
  <template #suffix>
  <slot name="suffix"></slot>
  </template>
  </el-input>
  </div>
  </template>
  <script setup>
  import { computed } from 'vue'
  const props = defineProps({
  modelValue: {
  type: String,
  default: ''
  },
  clearable: {
  type: Boolean,
  default: false
  }
  })
  const emits = defineEmits(['update:modelValue', 'clear'])
  const inputVal = computed({
  get: () => props.modelValue,
  set: (val) => {
  emits('update:modelValue', val)
  }
  })
  const clear = () => {
  emits('clear')
  }
  </script>

   但当需求发生变动,此时又要在MyInput组件上添加el-input组件的其它功能,可el-input组件总共有20个多属性,5个事件,4个插槽,这样是不是很繁琐,对我们这些想要“懒”的人,事不对不可以的,那该怎么办呢。

  在Vue2中,我们可以这样处理,点击此处查看封装Vue第三方组件

  此文诣在帮助大家做一个知识的迁移,探究如何使用Vue3 CompositionAPI优雅地封装第三方组件~

  一、对于第三方组件的属性props、事件events

  在Vue2中

  $attrs: 包含了父作用域中不作为 prop 被识别 (且获取) 的 attribute 绑定 (class 和 style 除外)。当一个组件没有声明任何prop 时,这里会包含所有父作用域的绑定 (class 和 style 除外),并且可以通过 v-bind="$attrs" 传入内部组件

  $listeners:包含了父作用域中的 (不含.native修饰器的)v-on事件监听器。它可以通过v-on="$listeners"传入内部组件

  而在Vue3中

  $attrs:包含了父作用域中不作为组件props或自定义事件的 attribute 绑定和事件(包括class和style和自定义事件),同时可以通过 v-bind="$attrs" 传入内部组件。

  $listeners对象在 Vue 3 中已被移除。事件监听器现在是$attrs的一部分。

  在<script setup>中辅助函数useAttrs可以获取到$attrs。 

 //MyInput.vue
  <template>
  <div class="my-input">
  <el-input v-bind="attrs"></el-input>
  </div>
  </template>
  <script setup>
  import { useAttrs } from 'vue'
  const attrs = useAttrs()
  </script>

  就算加上上面这些也是不够的。现在我们绑定的属性(包括class和style)同时会在根元素(上面的例子是class="my-input"的Dom节点)上起作用。要阻止这个默认行为,我们需要设置inheritAttrs为false。

  下面我们来看看Vue3文档对inheritAttrs的解释

  默认情况下父作用域的不被认作 props 的 attribute 绑定 (attribute bindings) 将会“回退”且作为普通的 HTML attribute 应用在子组件的根元素上。当撰写包裹一个目标元素或另一个组件的组件时,这可能不会总是符合预期行为。通过设置inheritAttrs到false,这些默认行为将会被去掉。而通过实例 property$attrs可以让这些 attribute 生效,且可以通过v-bind显性的绑定到非根元素上。

  于是,我们对于第三方组件的属性props、事件events处理,可以写成如下代码: 

 // MyInput.vue
  <template>
  <div class="my-input">
  <el-input v-bind="attrs"></el-input>
  </div>
  </template>
  <script>
  export default {
  name: 'MyInput',
  inheritAttrs: false
  }
  </script>
  <script setup>
  import { useAttrs } from 'vue'
  const attrs = useAttrs()
  </script>

  二、对于第三方组件的插槽slots

  Vue3中

  $slots:我们可以通过其拿到父组件传入的插槽

  Vue3中移除了$scopedSlots,所有插槽都通过$slots作为函数暴露

  在<script setup>中辅助函数useSlots可以获取到$slots。

  从上面几点看到,我们对于第三方组件的封装没有增加额外的插槽,且第三方组件的插槽处于同一个dom节点之中,我们也有一种取巧的封装方式????, 通过遍历$slots拿到插槽的name,动态添加子组件的插槽:

  //MyInput.vue
  <template>
  <div class="my-input">
  <el-input v-bind="attrs">
  <template v-for="k in Object.keys(slots)" #[k] :key="k">
  <slot :name="k"></slot>
  </template>
  </el-input>
  </div>
  </template>
  <script>
  export default {
  name: 'MyInput',
  inheritAttrs: false
  }
  </script>
  <script setup>
  import { useAttrs, useSlots } from 'vue'
  const attrs = useAttrs()
  const slots = useSlots()
  </script>

  上再不行,没办法就只要好,在子组件中手动添加需要的第三方组件的插槽~

  三、对于第三方组件的方法methods

  对于第三方组件的方法,我们通过ref来实现。首先在MyInput组件中的el-input组件上添加一个ref="elInputRef"属性,然后通过defineExpose把elInputRef暴露出去给父组件调用。

  子组件:MyInput.vue

  // MyInput.vue
  <template>
  <div class="my-input">
  <el-input v-bind="attrs" ref="elInputRef">
  <template v-for="k in Object.keys(slots)" #[k] :key="k">
  <slot :name="k"></slot>
  </template>
  </el-input>
  </div>
  </template>
  <script>
  export default {
  name: 'MyInput',
  inheritAttrs: false
  }
  </script>
  <script setup>
  import { useAttrs, useSlots } from 'vue'
  const attrs = useAttrs()
  const slots = useSlots()
  const elInputRef = ref(null)
  defineExpose({
  elInputRef // <script setup>的组件里的属性默认是关闭的,需通过defineExpose暴露出去才能被调用
  })
  </script>

  父页面:Index.vue的调用代码如下:

  // Index.vue
  <template>
  <my-input v-model='input' ref="myInput">
  <template #prefix>姓名</template>
  </my-input>
  </template>
  <script setup>
  import MyInput from './components/MyInput.vue'
  import { ref, onMounted } from 'vue'
  const input = ref('')
  const myInput = ref(null) // 组件实例
  onMounted(()=> {
  myInput.value.elInputRef.focus() // 初始化时调用elInputRef实例的focus方法
  })
  </script>

  以上就是Vue3 Composition API优雅封装第三方组件的详细内容,请大家好好学习深入了解。

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/128233.html

相关文章

  • 关于Vue2一些值得推荐的文章 -- 五、六月份

    摘要:五六月份推荐集合查看最新的请点击集前端最近很火的框架资源定时更新,欢迎一下。苏幕遮燎沈香宋周邦彦燎沈香,消溽暑。鸟雀呼晴,侵晓窥檐语。叶上初阳乾宿雨,水面清圆,一一风荷举。家住吴门,久作长安旅。五月渔郎相忆否。小楫轻舟,梦入芙蓉浦。 五、六月份推荐集合 查看github最新的Vue weekly;请::点击::集web前端最近很火的vue2框架资源;定时更新,欢迎 Star 一下。 苏...

    sutaking 评论0 收藏0
  • 关于Vue2一些值得推荐的文章 -- 五、六月份

    摘要:五六月份推荐集合查看最新的请点击集前端最近很火的框架资源定时更新,欢迎一下。苏幕遮燎沈香宋周邦彦燎沈香,消溽暑。鸟雀呼晴,侵晓窥檐语。叶上初阳乾宿雨,水面清圆,一一风荷举。家住吴门,久作长安旅。五月渔郎相忆否。小楫轻舟,梦入芙蓉浦。 五、六月份推荐集合 查看github最新的Vue weekly;请::点击::集web前端最近很火的vue2框架资源;定时更新,欢迎 Star 一下。 苏...

    khs1994 评论0 收藏0
  • 前方来报,八月最新资讯--关于vue2&3的最佳文章推荐

    摘要:哪吒别人的看法都是狗屁,你是谁只有你自己说了才算,这是爹教我的道理。哪吒去他个鸟命我命由我,不由天是魔是仙,我自己决定哪吒白白搭上一条人命,你傻不傻敖丙不傻谁和你做朋友太乙真人人是否能够改变命运,我不晓得。我只晓得,不认命是哪吒的命。 showImg(https://segmentfault.com/img/bVbwiGL?w=900&h=378); 出处 查看github最新的Vue...

    izhuhaodev 评论0 收藏0
  • Composition Api封装业务hook思路示例分享

      在近期的工作中有些知识总结分享就是使用 uniapp 的 Vue3 版进行开发。这样可以在开发中遇到业务场景相同的,就分装了一个hook 来减少代码,易于维护。  hook的场景  上图中已经很详细为我们展示3处使用到了获取列表的功能。分别是: 我的收藏、已投递岗位、未投递岗位。现在我们就来详细说说。  假如: 我的收藏、已投递岗位、未投递岗位 都各自获取列表,就会出现重复性的定义以下代码  ...

    3403771864 评论0 收藏0

发表评论

0条评论

3403771864

|高级讲师

TA的文章

阅读更多
最新活动
阅读需要支付1元查看
<