在vue中更优雅的封装第三方组件

29,792 阅读2分钟

在vue中更优雅的封装第三方组件

相关推荐:

约2万字-Vue源码解读汇总篇(续更)

前端要会打组合拳,复盘30+技术点打出的功能

一、需求场景描述

实际开发的时候,为了减少重复造轮子,提高工作效率,节省开发时间成本, 免不了会使用ui组件库,比如在web前端很受欢迎的element-ui。 但有的时候,我们需要在原组件的基础上做些改造,比如一个image组件, 我们需要统一在图片加载失败的时候展示的特定图,每次使用组件都加一遍, 麻烦耗时,关键是维护成本高,当需要更新这个加载出错的图片时, 得再次一个个去找到使用该组件的地方修改。

再例如自定义分页组件也很常见,组件的样式,默认支持的每页数目, 封装之后再用,在可维护性和开发效率上都很有好处。

然而也不至于从0开始写一个分页组件,在原有基础上封装就好, 那么如何快速优雅的封装一个第三方组件库的组件呢? v-bind="attrs"von="attrs" 和 v-on="listeners" ="$listeners",会给我们带来惊喜。 它们可以使得封装后的组件, “继承”原组件的几乎所有 v-bind 属性和 v-on 事件,且用法和作用与在原组件一样。

封装el-image 为 custom-image 组件,所有使用custom-image 展示图片的地方, 图片加载过程中都会统一展示“加载中...”的提示,且当加载出错时,会展示统一的默认图。 下面是一个 custom-image 组件加载过程以及加载出错的效果。

GIF 2022-4-15 15-58-13.gif

二、关键技术点介绍

1.v-bind="$attrs"

v-bind="$attrs"的妙用是在创建更高级别的组件,在封装第三方组件时,

可以自动将在父作用域中使用的v-bind的属性自动绑定,

并向下传入被封装的使用了v-bind="$attrs"的组件。

一段摘自 vue 官网的介绍

包含了父作用域中不作为 prop 被识别 (且获取) 的 attribute

绑定 (class 和 style 除外)。当一个组件没有声明任何 prop 时,

这里会包含所有父作用域的绑定 (class 和 style 除外),

并且可以通过 v-bind="$attrs" 传入内部组件——在创建高级别的组件时非常有用。

例如我们封装的custom-Image组件,使用了v-bind="$attrs"之后, 我们在custom-Image组件中,也拥有了el-image的几乎所有属性, 而且其作用效果和用法,是和我们使用el-image是一样的, 也就说我们可以看着el-image的文章去使用custom-Image。

2.v-on="$listeners"

v-on="listeners"的作用和用法与vbind="listeners"的作用和用法与v-bind="attrs"类似, 它可以将父作用域中的使用v-on的时间监听器向下传入到使用了v-on="listeners"组件中,和vbind="listeners"组件中, 和v-bind="attrs"的功效类似,只不过一个属性一个是事件。还是custom-Image组件为例, 这时候custom-Image组件就拥有了el-image组件的几乎所有事件。 而且其作用效果和用法,是和我们使用el-image是一样的。

包含了父作用域中的 (不含 .native 修饰器的) v-on 事件监听器。

它可以通过 v-on="$listeners" 传入内部组件——在创建更高层次的组件时非常有用。

一段摘自 vue 官网的介绍

三、封装el-image的代码示例

使用custom-Image组件的示例

<custom-Image fit="fill" class="icon-img" :src="picPreview(expert)"></custom-Image>

封装el-image为custom-Image组件的示例

<template>
  <div id="CustomImage">
    <el-image v-bind="$attrs" v-on="$listeners">
      <div slot="error" class="image-slot">
        <img :src="require('image-f/icon-empty-img.png')" alt="图片加载失败.png"/>
      </div>
      <div slot="placeholder" class="placeholder-slot">加载中...</div>
    </el-image>
  </div>
</template>

<script>
export default {
  name: 'CustomImage'
}
</script>

<style scoped lang="scss">
  #CustomImage {
  .image-slot {
    text-align: center;
  }

  .placeholder-slot {
    text-align: center;
  }
}
</style>

四、vue3 中的变化

①前面的方式都是基于 vue2 的写法。vue3 中 v-bind="attrs"包含了von="attrs" 包含了 v-on="listeners" 的作用。

②自动透传。vue3 中,当一个组件以单个元素为根作渲染时,透传的 attribute 会自动被添加到根元素上。

③如果你不想要一个组件自动地继承 attribute,你可以在组件选项中设置 inheritAttrs: false

④vue2 要求唯一根节点,vue1 和 vue3 却是支持多根节点。和单根节点组件有所不同,有着多个根节点的组件没有自动 attribute 透传行为。如果 $attrs 没有被显式绑定,将会抛出一个运行时警告。

文档:更多更于 vue3 中的透传 Attributes