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封装表格组件内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • vue3中使用keepAlive缓存路由组件不生效的问题解决

    vue3中使用keepAlive缓存路由组件不生效的问题解决

    这篇文章主要介绍了vue3中使用keepAlive缓存路由组件不生效的问题解决,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧
    2024-06-06
  • Vue Element前端应用开发之动态菜单和路由的关联处理

    Vue Element前端应用开发之动态菜单和路由的关联处理

    这篇文章主要介绍了Vue Element前端应用开发之动态菜单和路由的关联处理,对vue感兴趣的同学,可以参考下
    2021-05-05
  • Vue列表渲染的示例代码

    Vue列表渲染的示例代码

    这篇文章主要介绍了Vue列表渲染的示例代码,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-11-11
  • Vue组件通信深入分析

    Vue组件通信深入分析

    对于vue来说,组件之间的消息传递是非常重要的,用vue可以是要组件复用的,而组件实例的作用域是相互独立,这意味着不同组件之间的数据无法互相引用,一般来说,组件之间可以有几种关系,下面是我对组件之间消息传递的常用方式的总结
    2022-08-08
  • vue项目中公用footer组件底部位置的适配问题

    vue项目中公用footer组件底部位置的适配问题

    footer为公用组件,其他页面都需要引入。接下来通过本文给大家分享vue项目中公用footer组件底部位置的适配问题,需要的朋友可以参考下
    2018-05-05
  • vue3的介绍和两种创建方式详解(cli和vite)

    vue3的介绍和两种创建方式详解(cli和vite)

    这篇文章主要介绍了vue3的介绍和两种创建方式(cli和vite),vue3对比vue2带来的性能提升有很多优势,总体来说Vue 3在性能、开发体验和代码组织方面都有所改进,使得它更加适合于大型、复杂的应用程序开发,需要的朋友可以参考下
    2023-04-04
  • vuex状态管理数据状态查询与更改方式

    vuex状态管理数据状态查询与更改方式

    这篇文章主要介绍了vuex状态管理数据状态查询与更改方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-04-04
  • vue在install时node-sass@4.14.1 postinstall:node scripts/build.js错误解决

    vue在install时node-sass@4.14.1 postinstall:node scripts/buil

    最近在npm install 的时候遇到了个问题,所以给大家总结下,下面这篇文章主要给大家介绍了关于vue在install时node-sass@4.14.1 postinstall:node scripts/build.js错误的解决方法,需要的朋友可以参考下
    2023-05-05
  • Element-UI介绍主题定制、自定义组件和插件扩展的代码示例

    Element-UI介绍主题定制、自定义组件和插件扩展的代码示例

    本文介绍了使用Element-UI实现主题定制、自定义组件和扩展插件的方法和实用案例,在开发过程中,我们可以根据自己的需求,灵活选择相关的技术手段,并不断探索和尝试,以提高开发效率和用户体验,感兴趣的朋友跟随小编一起看看吧
    2024-02-02
  • vueJs实现DOM加载完之后自动下拉到底部的实例代码

    vueJs实现DOM加载完之后自动下拉到底部的实例代码

    这篇文章主要介绍了vueJs实现DOM加载完成之后自动下拉到底部的实例代码,非常不错,具有一定的参考借鉴价值,需要的朋友可以参考下
    2018-08-08

最新评论