vue3 + ElementPlus 封装列表表格组件包含分页

 更新时间:2025年02月06日 09:37:04   作者:scorpion_V  
文章介绍了如何在Vue3和ElementPlus中封装一个包含分页功能的通用列表表格组件,组件通过props接收表格数据、列配置、总条数、加载状态和分页配置,并通过events处理分页和刷新事件,此外,还提供了自定义列内容和操作按钮的功能,感兴趣的朋友跟随小编一起看看吧

在前端开发中,封装组件是必不可少的。今天就来封装一个通用的列表表格组件,包含分页功能,可以提高代码的复用性和可维护性。

1. 组件设计

Props:

  • tableData:表格数据。
  • columns:表格列配置。
  • total:总条数。
  • loading:加载状态。
  • pagination:分页配置(当前页、每页条数)。

Events:

  • update:pagination:分页变化时触发。
  • refresh:刷新数据时触发。

Slots:

  • 自定义列内容。
  • 自定义操作按钮。

2. 封装代码

TableWithPagination.vue

<template>
  <div class="table-with-pagination">
    <!-- 表格 -->
    <el-table
      :data="tableData"
      border
      stripe
      v-loading="loading"
      style="width: 100%"
    >
      <!-- 动态列 -->
      <el-table-column
        v-for="column in columns"
        :key="column.prop"
        :prop="column.prop"
        :label="column.label"
        :width="column.width"
        :align="column.align || 'center'"
      >
        <!-- 自定义列内容 -->
        <template #default="scope" v-if="column.slot">
          <slot :name="column.slot" :row="scope.row"></slot>
        </template>
      </el-table-column>
      <!-- 操作列 -->
      <el-table-column
        v-if="$slots.actions"
        label="操作"
        align="center"
        :width="actionsWidth"
      >
        <template #default="scope">
          <slot name="actions" :row="scope.row"></slot>
        </template>
      </el-table-column>
    </el-table>
    <!-- 分页 -->
    <el-pagination
      class="pagination"
      background
      layout="total, sizes, prev, pager, next, jumper"
      :total="total"
      :page-size="pagination.pageSize"
      :current-page="pagination.pageNo"
      @size-change="handleSizeChange"
      @current-change="handleCurrentChange"
    />
  </div>
</template>
<script setup>
import { ref, watch } from 'vue';
const props = defineProps({
  tableData: {
    type: Array,
    default: () => [],
  },
  columns: {
    type: Array,
    default: () => [],
  },
  total: {
    type: Number,
    default: 0,
  },
  loading: {
    type: Boolean,
    default: false,
  },
  pagination: {
    type: Object,
    default: () => ({
      pageNo: 1,
      pageSize: 10,
    }),
  },
  actionsWidth: {
    type: String,
    default: '180',
  },
});
const emit = defineEmits(['update:pagination', 'refresh']);
// 分页大小变化
const handleSizeChange = (pageSize) => {
  emit('update:pagination', { ...props.pagination, pageSize });
  emit('refresh');
};
// 当前页变化
const handleCurrentChange = (pageNo) => {
  emit('update:pagination', { ...props.pagination, pageNo });
  emit('refresh');
};
</script>
<style scoped>
.table-with-pagination {
  margin-top: 20px;
}
.pagination {
  margin-top: 20px;
  text-align: right;
}
</style>

3. 使用示例 

<template>
  <div>
    <!-- 搜索栏 -->
    <el-form :inline="true" :model="queryParams">
      <el-form-item label="任务名称">
        <el-input v-model="queryParams.taskName" placeholder="请输入任务名称" />
      </el-form-item>
      <el-form-item>
        <el-button type="primary" @click="handleSearch">搜索</el-button>
      </el-form-item>
    </el-form>
    <!-- 表格组件 -->
    <TableWithPagination
      :table-data="tableData"
      :columns="columns"
      :total="total"
      :loading="loading"
      :pagination="pagination"
      @update:pagination="handlePaginationChange"
      @refresh="fetchData"
    >
      <!-- 自定义列 -->
      <template #status="{ row }">
        <el-tag :type="row.status === 1 ? 'success' : 'danger'">
          {
  { row.status === 1 ? '启用' : '禁用' }}
        </el-tag>
      </template>
      <!-- 操作列 -->
      <template #actions="{ row }">
        <el-button type="primary" size="small" @click="handleEdit(row)">
          编辑
        </el-button>
        <el-button type="danger" size="small" @click="handleDelete(row)">
          删除
        </el-button>
      </template>
    </TableWithPagination>
  </div>
</template>
<script setup>
import { ref, onMounted } from 'vue';
import TableWithPagination from './components/TableWithPagination.vue';
import { fetchTaskList } from '@/api/task'; // 假设有一个获取任务列表的 API
// 表格列配置
const columns = [
  { prop: 'taskName', label: '任务名称' },
  { prop: 'taskType', label: '任务类型' },
  { prop: 'status', label: '状态', slot: 'status' }, // 使用自定义列
];
// 表格数据
const tableData = ref([]);
const total = ref(0);
const loading = ref(false);
// 查询参数
const queryParams = ref({
  taskName: '',
});
// 分页参数
const pagination = ref({
  pageNo: 1,
  pageSize: 10,
});
// 获取数据
const fetchData = async () => {
  try {
    loading.value = true;
    const res = await fetchTaskList({
      ...queryParams.value,
      ...pagination.value,
    });
    tableData.value = res.data.list;
    total.value = res.data.total;
  } catch (error) {
    console.error('获取数据失败:', error);
  } finally {
    loading.value = false;
  }
};
// 分页变化
const handlePaginationChange = (newPagination) => {
  pagination.value = newPagination;
  fetchData();
};
// 搜索
const handleSearch = () => {
  pagination.value.pageNo = 1; // 重置页码
  fetchData();
};
// 编辑
const handleEdit = (row) => {
  console.log('编辑:', row);
};
// 删除
const handleDelete = (row) => {
  console.log('删除:', row);
};
// 初始化加载数据
onMounted(() => {
  fetchData();
});
</script>

父组件中使用 TableWithPagination以上就是封装 Vue 3 和 Element Plus 中封装一个通用的列表表格组件,将表格和分页逻辑封装在一个组件中,便于维护和扩展。

到此这篇关于vue3 + ElementPlus 封装列表表格组件包含分页的文章就介绍到这了,更多相关vue ElementPlus封装表格组件内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • el-select选择器组件下拉框增加自定义按钮的实现

    el-select选择器组件下拉框增加自定义按钮的实现

    本文主要介绍了el-select选择器组件下拉框增加自定义按钮的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2024-07-07
  • vue前端优雅展示后端十万条数据面试点剖析

    vue前端优雅展示后端十万条数据面试点剖析

    这篇文章主要为大家介绍了vue前端优雅展示后端十万条数据的考点剖析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-07-07
  • unplugin-auto-import的配置以及eslint报错解决详解

    unplugin-auto-import的配置以及eslint报错解决详解

    unplugin-auto-import 解决了vue3-hook、vue-router、useVue等多个插件的自动导入,也支持自定义插件的自动导入,是一个功能强大的typescript支持工具,这篇文章主要给大家介绍了关于unplugin-auto-import的配置以及eslint报错解决的相关资料,需要的朋友可以参考下
    2022-08-08
  • vue3+vite项目中按需引入vant报错:Failed to resolve import的解决方案

    vue3+vite项目中按需引入vant报错:Failed to resolve import的解决方案

    最近在vue项目中引入vant的时候发现报错了,经过尝试发现了问题,现将完整引入流程提供给大家参考,下面这篇文章主要给大家介绍了关于vue3+vite项目中按需引入vant报错:Failed to resolve import的解决方案,需要的朋友可以参考下
    2022-12-12
  • 安装vue3开发者工具但控制台没有显示出vue选项的解决

    安装vue3开发者工具但控制台没有显示出vue选项的解决

    这篇文章主要介绍了安装vue3开发者工具但控制台没有显示出vue选项的解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-10-10
  • vue 路由视图 router-view嵌套跳转的实现

    vue 路由视图 router-view嵌套跳转的实现

    这篇文章主要介绍了vue 路由视图 router-view嵌套跳转,主要实现的内容有制作一个登录页面,跳转到首页,首页包含菜单栏、顶部导航栏、主体,标准的后台网页格式,菜单点击显示不同的页面,感兴趣的小伙伴请参考下面文章内容
    2021-09-09
  • element-ui el-select下拉框el-date-picker弹出框定位问题解决方案(推荐)

    element-ui el-select下拉框el-date-picker弹出框定位问题解决方案(推荐)

    项目开发过程中发现el-select和el-date-picker弹出框显示时候,滚动屏幕,导致弹出框定位出现问题,这篇文章主要介绍了element-ui el-select下拉框el-date-picker弹出框定位问题解决方案(推荐),需要的朋友可以参考下
    2024-07-07
  • vue项目打包清除console.log的四种方法总结

    vue项目打包清除console.log的四种方法总结

    大家在项目开发的时候,需要看看一些后端接口返回的结果,会多次使用console.log项目开发完成打包的时候,发现控制台一堆的console.log,非常头疼,下面这篇文章主要给大家介绍了关于vue项目打包清除console.log的四种方法,需要的朋友可以参考下
    2023-04-04
  • Vue中的 mixins 和 provide/inject详解

    Vue中的 mixins 和 provide/inject详解

    这篇文章主要介绍了Vue中的 mixins 和 provide/inject详解,本文结合实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-07-07
  • 五步教你用Nginx部署Vue项目及解决动态路由刷新404问题

    五步教你用Nginx部署Vue项目及解决动态路由刷新404问题

    nginx 是一个代理的服务器,下面这篇文章主要给大家介绍了关于如何通过五步教你用Nginx部署Vue项目及解决动态路由刷新404问题的相关资料,文中通过图文介绍的非常详细,需要的朋友可以参考下
    2022-12-12

最新评论