vue3 | el-table表格二次封装_el-table封装-程序员宅基地

技术标签: 前端  vue.js  javascript  

需求

1.统一样式,通过slot插槽而非json配置项的形式,来兼容原有table的template写法,方便改造
2.列的显示隐藏控制,默认根据接口数据是否有返回绑定prop对应的字段,来实现列的权限控制显隐,也可通过外部传tableHeader来自行控制
3.合并分页器

myTable.vue

<!--
 * @Description: 公共table组件,可含分页器
 * @使用方法:将<el-table>标签名替换为<my-table>即可, v-loading 指令需改为 :loading 绑定,其他所有属性方法的绑定和使用都和element-plus的table一致
 * @个别事项: 
    1. 使用分页器需绑定 showPagination, 并传一个json配置参数 paginationConfig, 除了 @size-change 和 @current-change 两个方法直接绑定在table上外,分页器的其他原有属性统一加到 paginationConfig
    2. tableHeader:默认只会渲染显示列表接口有返回的字段对应的prop列, 传了 tableHeader 则只会渲染 tableHeader 里有定义的字段列

 * @例:
    <my-table
      :loading="loading"
      :data="data"
      @selection-change="selectTableChange"
      @cell-click="selectRowFun"
      :multipleSelection="multipleSelection"
      showPagination
      :paginationConfig="paginationConfig"
      @size-change="handleSizeChange"
      @current-change="handleCurrentChange"
    >
      <el-table-column type="selection" width="55" />
      <el-table-column prop="name" label="姓名" width="150"></el-table-column>
      <el-table-column prop="ages" label="年龄" width="150"></el-table-column>
    <my-table/>
-->

<template>
  <el-table 
    v-bind="$attrs" 
    ref="table" 
    v-loading="loading" 
    :data="data"
    :max-height="maxHeight"
    :paginationConfig="null"
  >
    <children :key="key" />
  </el-table>
  <div class="operation-bar">
    <div class="left-operation">
      <div class="checkedCount" v-if="showCheckedCount">已选 {
    {
     multipleSelection.length }}</div>
      <div class="operation-box">
        <slot name="operation"></slot>
      </div>
    </div>
    <div class="right-pagination">
      <pagination v-if="showPagination" :pageConfig="_paginationConfig" @size-change="pageSizeChange" @current-change="currentPageChange" />
    </div>
  </div>
</template>

<script lang="ts" setup>
  import {
    
    cloneVNode,
    Component,
    computed,
    reactive,
    ref,
    VNode,
    readonly,
    useSlots,
    defineExpose,
    watch,
    defineProps,
    defineEmits,
    useAttrs,
    nextTick,
    onMounted,
    onBeforeUnmount,
  } from 'vue'

  import pagination from './pagination.vue' // 分页组件
  // import useVirtualScroll from './useVirtualScroll'

  const props = defineProps({
    
    loading: {
    
      type: Boolean,
      default: false,
    },
    
    maxHeight: {
    
      type: [String, Number],
      default: 720,
    },

    data: {
    
      type: Array,
      default: () => []
    },

    // 显示已选数量
    showCheckedCount: {
    
      type: Boolean,
      default: false,
    },

    // 绑定的已选项数组
    multipleSelection: {
    
      type: Array,
      default: () => []
    },

    // 可见的字段表头 ['filed1', 'filed2', 'filed3']
    tableHeader: {
    
      type: Object,
      default: () => []
    },
    // 关闭自适应列宽 (用于解决列数小于3的表格在渲染时会出现数据抖动)
    closeAutoCloumnWidth: {
    
      type: Boolean,
      default: false
    },

    // 使用分页器
    showPagination: {
    
      type: Boolean,
      default: false
    },
    
    // 分页配置
    paginationConfig: {
    
      type: Object,
      default: () => {
    
        return {
    
          total: 0,
          currentPage: 1,
          pageSize: 10,
          pageSizes:[10, 30, 50, 100, 200, 500]
        }
      },
    },
  })

  const emit = defineEmits([
    "currentChange",
    "sizeChange",
  ]);
  

  interface IMyTableColumnProps {
    
    prop?: string
    label?: string
    fixed?: 'left' | 'right' | boolean
    visiable?: boolean
    index?: boolean
  }

  function isElTableColumn(vnode: VNode) {
    
    return (vnode.type as Component)?.name === 'ElTableColumn'
  }

  const table = ref()
  let tableHeader:any = {
    }
  let headerCount: number = 0
  
  const slotsOrigin = useSlots()
  const attrs:any = useAttrs()
  const slots = computed(() => {
    
    /* 对 slot 进行分类 */
    const main: VNode[] = [] // ElTableColumn 且存在 prop 属性
    const left: VNode[] = [] // ElTableColumn 不存在 prop 属性,但 fixed="left" 或者为 selection选框
    const other: VNode[] = [] // 其他

    // 权限控制的可见列字段
    let showKeys: string[] = [];
    
    // 方式一:只显示接口返回的字段判断 (设置了字段可见权限,接口不会返回该相关字段)
    if(props.data && props.data.length){
    
      let tableDataItem: any = props.data[0]
      showKeys = Object.keys(tableDataItem)
    }
    let isNullData = showKeys.length || props.tableHeader ? false : true; // 空数据时正常渲染表头

    // 方式二:用外部传来的表头字段
    console.log('外部props.tableHeader', props.tableHeader)
    if(props.tableHeader){
    
      tableHeader = JSON.parse(JSON.stringify(props.tableHeader));
    }

    if(JSON.stringify(tableHeader) !== '{}'){
    
      showKeys = Object.keys(tableHeader).map(v=>v.replace(/^./, (L) => L.toLowerCase())) // 首字母转小写
    }

    slotsOrigin.default?.()?.forEach((vnode, index) => {
    
      if(!vnode.props){
    
        vnode.props = {
    }
      }
      vnode.props.index = index; // 排序
      if (isElTableColumn(vnode)) {
    
        if(vnode.props && vnode.props.prop){
    
          if(!isNullData){
    
            vnode.props.visiable = showKeys.indexOf(vnode.props.prop) === -1 ? false : true;
          }
          
          // 构建可见列表头并缓存起来
          if(props.data && vnode.props.visiable){
    
            tableHeader[vnode.props.prop] = vnode.props.label
          }else{
    
            delete tableHeader[vnode.props.prop]
          }
        }
    
        const {
     prop, fixed, type } = vnode.props ?? {
    }
        if (prop !== undefined) return main.push(vnode)
        // if (type === 'selection' && vnode.props)  vnode.props.reserveSelection = true;
        if (fixed === 'left' || type === 'selection') return left.push(vnode)
      }
      other.push(vnode)
    })
    
    console.log('实际tableHeader',tableHeader)

    // 可见内容列少于3列则自适应宽度, 防止列数过少时撑不满table宽度出现断层
    let showMain = main.filter(v=>{
    return v.props && v.props.visiable !== false});
    if(!props.closeAutoCloumnWidth && showKeys.length && showMain.length < 3){
    
      main.forEach(vnode=>{
    
        if(vnode.props) vnode.props.width = ''
      })
      key.value++
    }
    if(!props.closeAutoCloumnWidth && !showMain.length && other.length && other[0].props){
    
      other[0].props.width = ''
      key.value++
    }

    return {
    
      main,
      left,
      other,
    }
  })

  /* 列的排序与部分属性 */
  const columns = reactive({
    

    // slot 中获取的
    slot: computed(() =>
      slots.value.main.map(({
     props }) => ({
    
        prop: props!.prop,
        label: props!.label,
        fixed: props!.fixed,
        visiable: props!.visiable ?? true,
      }))
    ),

    // 渲染使用的
    render: computed(() => {
    
      const res: IMyTableColumnProps[] = []
      const slot = [...columns.slot]
      res.push(...slot)

      return res
    }),
  })

  /* 重构 slot.main */
  const refactorSlot = computed(() => {
    
    const {
     main } = slots.value

    /* 对 slot.main 进行改写 */
    const refactorySlot: VNode[] = []
    columns.render.forEach(({
     prop, visiable, fixed }) => {
    
      if (!visiable) return

      const vnode = main.find((vnode) => prop === vnode.props?.prop)
      if (!vnode) return

      const cloned = cloneVNode(vnode, {
    
        fixed,
      })

      refactorySlot.push(cloned)
    })

    return refactorySlot
  })

  /* 强制更新 el-table-column */
  const key = ref(0)
  watch(refactorSlot, () => {
    
    if(Object.keys(tableHeader).length !== headerCount){
    
      // 初始表头已构建好则无需更新,否则数据刷新时会抖动闪烁
      headerCount = Object.keys(tableHeader).length;
      key.value += 1
      nextTick(()=>{
    
        table.value.doLayout()
      })
    }
  })

  /* 对外暴露的内容 */
  defineExpose({
    
    table, // el-table 实例的访问

    columns: computed(() => readonly(columns.render)),
    updateColumns(value: IMyTableColumnProps[]) {
    

    },
  })

  const children = () => [...slots.value.left, ...refactorSlot.value, ...slots.value.other].sort((a: any, b: any)=>a.props.index - b.props.index)
  console.log(children())

  // 合并分页配置
  const _paginationConfig = computed(() => {
    
    const config = {
    
      total: 0,
      currentPage: 1,
      pageSize: 10,
      pageSizes: [10, 30, 50, 100, 200, 500],
      layout: "total, sizes, prev, pager, next, jumper",
    };
    return Object.assign(config, props.paginationConfig);
  });

  // 切换分页
  const currentPageChange = (pageIndex: number) => {
    
    emit("currentChange", pageIndex);
  }
  const pageSizeChange = (pageSize: number) => {
    
    emit("sizeChange", pageSize);
  }


  // 虚拟滚动
  // const { visibleData, initVirtualScroll, handleSelectionAll, addListeners, removeListeners, getRowKeys} = useVirtualScroll();
  // watch(()=>props.data, ()=>{
    
  //   initVirtualScroll(table, JSON.parse(JSON.stringify(props.data)))
  // })

  // onMounted(()=>{
    
  //   addListeners()
  // })
  
  // onBeforeUnmount(()=>{
    
  //   removeListeners()
  // })

</script>

<style lang="less" scoped>
  .operation-bar{
    
    display: flex;
    justify-content: space-between;
    align-items: flex-end;
    .left-operation{
    
      text-align: left;
      .checkedCount{
    
        // padding-left: 10px;
        font-size: 14px;
        font-weight: 400;
        color: #606266;
        padding: 10px 0 10px 10px;
      }
    }
  }
</style>

pagination.vue

<template>
    <el-pagination v-bind="pageConfig"></el-pagination>
</template>
<script lang="ts" setup>
  import {
     defineProps } from "vue";
  defineProps({
    
      pageConfig: {
    
          type: Object,
          default: () => ({
    })
      }
  })
</script>
版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/weixin_45829115/article/details/130449407

智能推荐

JWT(Json Web Token)实现无状态登录_无状态token登录-程序员宅基地

文章浏览阅读685次。1.1.什么是有状态?有状态服务,即服务端需要记录每次会话的客户端信息,从而识别客户端身份,根据用户身份进行请求的处理,典型的设计如tomcat中的session。例如登录:用户登录后,我们把登录者的信息保存在服务端session中,并且给用户一个cookie值,记录对应的session。然后下次请求,用户携带cookie值来,我们就能识别到对应session,从而找到用户的信息。缺点是什么?服务端保存大量数据,增加服务端压力 服务端保存用户状态,无法进行水平扩展 客户端请求依赖服务.._无状态token登录

SDUT OJ逆置正整数-程序员宅基地

文章浏览阅读293次。SDUT OnlineJudge#include<iostream>using namespace std;int main(){int a,b,c,d;cin>>a;b=a%10;c=a/10%10;d=a/100%10;int key[3];key[0]=b;key[1]=c;key[2]=d;for(int i = 0;i<3;i++){ if(key[i]!=0) { cout<<key[i.

年终奖盲区_年终奖盲区表-程序员宅基地

文章浏览阅读2.2k次。年终奖采用的平均每月的收入来评定缴税级数的,速算扣除数也按照月份计算出来,但是最终减去的也是一个月的速算扣除数。为什么这么做呢,这样的收的税更多啊,年终也是一个月的收入,凭什么减去12*速算扣除数了?这个霸道(不要脸)的说法,我们只能合理避免的这些跨级的区域了,那具体是那些区域呢?可以参考下面的表格:年终奖一列标红的一对便是盲区的上下线,发放年终奖的数额一定一定要避免这个区域,不然公司多花了钱..._年终奖盲区表

matlab 提取struct结构体中某个字段所有变量的值_matlab读取struct类型数据中的值-程序员宅基地

文章浏览阅读7.5k次,点赞5次,收藏19次。matlab结构体struct字段变量值提取_matlab读取struct类型数据中的值

Android fragment的用法_android reader fragment-程序员宅基地

文章浏览阅读4.8k次。1,什么情况下使用fragment通常用来作为一个activity的用户界面的一部分例如, 一个新闻应用可以在屏幕左侧使用一个fragment来展示一个文章的列表,然后在屏幕右侧使用另一个fragment来展示一篇文章 – 2个fragment并排显示在相同的一个activity中,并且每一个fragment拥有它自己的一套生命周期回调方法,并且处理它们自己的用户输_android reader fragment

FFT of waveIn audio signals-程序员宅基地

文章浏览阅读2.8k次。FFT of waveIn audio signalsBy Aqiruse An article on using the Fast Fourier Transform on audio signals. IntroductionThe Fast Fourier Transform (FFT) allows users to view the spectrum content of _fft of wavein audio signals

随便推点

Awesome Mac:收集的非常全面好用的Mac应用程序、软件以及工具_awesomemac-程序员宅基地

文章浏览阅读5.9k次。https://jaywcjlove.github.io/awesome-mac/ 这个仓库主要是收集非常好用的Mac应用程序、软件以及工具,主要面向开发者和设计师。有这个想法是因为我最近发了一篇较为火爆的涨粉儿微信公众号文章《工具武装的前端开发工程师》,于是建了这么一个仓库,持续更新作为补充,搜集更多好用的软件工具。请Star、Pull Request或者使劲搓它 issu_awesomemac

java前端技术---jquery基础详解_简介java中jquery技术-程序员宅基地

文章浏览阅读616次。一.jquery简介 jQuery是一个快速的,简洁的javaScript库,使用户能更方便地处理HTML documents、events、实现动画效果,并且方便地为网站提供AJAX交互 jQuery 的功能概括1、html 的元素选取2、html的元素操作3、html dom遍历和修改4、js特效和动画效果5、css操作6、html事件操作7、ajax_简介java中jquery技术

Ant Design Table换滚动条的样式_ant design ::-webkit-scrollbar-corner-程序员宅基地

文章浏览阅读1.6w次,点赞5次,收藏19次。我修改的是表格的固定列滚动而产生的滚动条引用Table的组件的css文件中加入下面的样式:.ant-table-body{ &amp;amp;::-webkit-scrollbar { height: 5px; } &amp;amp;::-webkit-scrollbar-thumb { border-radius: 5px; -webkit-box..._ant design ::-webkit-scrollbar-corner

javaWeb毕设分享 健身俱乐部会员管理系统【源码+论文】-程序员宅基地

文章浏览阅读269次。基于JSP的健身俱乐部会员管理系统项目分享:见文末!

论文开题报告怎么写?_开题报告研究难点-程序员宅基地

文章浏览阅读1.8k次,点赞2次,收藏15次。同学们,是不是又到了一年一度写开题报告的时候呀?是不是还在为不知道论文的开题报告怎么写而苦恼?Take it easy!我带着倾尽我所有开题报告写作经验总结出来的最强保姆级开题报告解说来啦,一定让你脱胎换骨,顺利拿下开题报告这个高塔,你确定还不赶快点赞收藏学起来吗?_开题报告研究难点

原生JS 与 VUE获取父级、子级、兄弟节点的方法 及一些DOM对象的获取_获取子节点的路径 vue-程序员宅基地

文章浏览阅读6k次,点赞4次,收藏17次。原生先获取对象var a = document.getElementById("dom");vue先添加ref <div class="" ref="divBox">获取对象let a = this.$refs.divBox获取父、子、兄弟节点方法var b = a.childNodes; 获取a的全部子节点 var c = a.parentNode; 获取a的父节点var d = a.nextSbiling; 获取a的下一个兄弟节点 var e = a.previ_获取子节点的路径 vue