当前位置：首页 > news >正文

vxe-table 如何实现分页勾选复选框功能，分页后还能支持多选的选中状态

news 2026/5/12 16:28:50

vxe-table 如何实现分页勾选复选框功能，分页后还能支持多选的选中状态，要实现这个功能，有多种方式

https://vxetable.cn

可以使用一个变量来记录已选的数据，在分页时重新赋值选中状态。
使用内置的选中状态记忆保留功能，可以直接使用，无需再额外写代码

分页多选保留状态

当使用数据分页与复选框多页选中时，可以通过 checkbox-config.reserve 启用，将不会自动清除勾选数据，如果清除，可以调用 clearCheckboxReserve 方法手动清除已保留的选中数据

<template><div><vxe-button status="success" @click="getSelectEvent">获取已选</vxe-button><vxe-grid ref="gridRef" v-bind="gridOptions" v-on="gridEvents"></vxe-grid></div>
</template><script setup>
import { ref, reactive } from 'vue'
import { VxeUI } from 'vxe-table'const gridRef = ref()const allList = [{ id: 10001, name: 'Test1', nickname: 'T1', role: 'Develop', sex: 'Man', age: 28, address: 'Shenzhen' },{ id: 10002, name: 'Test2', nickname: 'T2', role: 'Test', sex: 'Women', age: 22, address: 'Guangzhou' },{ id: 10003, name: 'Test3', nickname: 'T3', role: 'PM', sex: 'Man', age: 32, address: 'Shanghai' },{ id: 10004, name: 'Test4', nickname: 'T4', role: 'Designer', sex: 'Women', age: 23, address: 'test abc' },{ id: 10005, name: 'Test5', nickname: 'T5', role: 'Develop', sex: 'Women', age: 30, address: 'Shanghai' },{ id: 10006, name: 'Test6', nickname: 'T6', role: 'Designer', sex: 'Women', age: 21, address: 'Shenzhen' },{ id: 10007, name: 'Test7', nickname: 'T7', role: 'Test', sex: 'Man', age: 29, address: 'Shenzhen' },{ id: 10008, name: 'Test8', nickname: 'T8', role: 'Develop', sex: 'Man', age: 35, address: 'test abc' },{ id: 10009, name: 'Test9', nickname: 'T9', role: 'Develop', sex: 'Man', age: 35, address: 'Shenzhen' },{ id: 100010, name: 'Test10', nickname: 'T10', role: 'Develop', sex: 'Man', age: 35, address: 'Guangzhou' },{ id: 100011, name: 'Test11', nickname: 'T11', role: 'Develop', sex: 'Man', age: 49, address: 'Guangzhou' },{ id: 100012, name: 'Test12', nickname: 'T12', role: 'Develop', sex: 'Women', age: 45, address: 'Shanghai' },{ id: 100013, name: 'Test13', nickname: 'T13', role: 'Test', sex: 'Women', age: 35, address: 'Guangzhou' },{ id: 100014, name: 'Test14', nickname: 'T14', role: 'Test', sex: 'Man', age: 29, address: 'Shanghai' },{ id: 100015, name: 'Test15', nickname: 'T15', role: 'Develop', sex: 'Man', age: 39, address: 'Guangzhou' },{ id: 100016, name: 'Test16', nickname: 'T16', role: 'Test', sex: 'Women', age: 35, address: 'Guangzhou' },{ id: 100017, name: 'Test17', nickname: 'T17', role: 'Test', sex: 'Man', age: 39, address: 'Shanghai' },{ id: 100018, name: 'Test18', nickname: 'T18', role: 'Develop', sex: 'Man', age: 44, address: 'Guangzhou' },{ id: 100019, name: 'Test19', nickname: 'T19', role: 'Develop', sex: 'Man', age: 39, address: 'Guangzhou' },{ id: 100020, name: 'Test20', nickname: 'T20', role: 'Test', sex: 'Women', age: 35, address: 'Guangzhou' },{ id: 100021, name: 'Test21', nickname: 'T21', role: 'Test', sex: 'Man', age: 39, address: 'Shanghai' },{ id: 100022, name: 'Test22', nickname: 'T22', role: 'Develop', sex: 'Man', age: 44, address: 'Guangzhou' }
]const pagerVO = reactive({total: 0,currentPage: 1,pageSize: 10
})const gridOptions = reactive({showOverflow: true,border: true,loading: false,height: 500,rowConfig: {keyField: 'id'},checkboxConfig: {reserve: true},pagerConfig: pagerVO,columns: [{ type: 'checkbox', width: 60 },{ field: 'name', title: 'Name', minWidth: 160 },{ field: 'email', title: 'Email', minWidth: 160 },{ field: 'nickname', title: 'Nickname', minWidth: 160 },{ field: 'age', title: 'Age', width: 100 },{ field: 'role', title: 'Role', minWidth: 160 },{ field: 'amount', title: 'Amount', width: 140 },{ field: 'updateDate', title: 'Update Date', visible: false },{ field: 'createDate', title: 'Create Date', visible: false }],data: []
})// 模拟前端分页
const handlePageData = () => {gridOptions.loading = truesetTimeout(() => {const { pageSize, currentPage } = pagerVOpagerVO.total = allList.lengthgridOptions.data = allList.slice((currentPage - 1) * pageSize, currentPage * pageSize)gridOptions.loading = false}, 100)
}const gridEvents = {pageChange ({ pageSize, currentPage }) {pagerVO.currentPage = currentPagepagerVO.pageSize = pageSizehandlePageData()}
}const getSelectEvent = () => {const $grid = gridRef.valueif ($grid) {const selectRecords = $grid.getCheckboxRecords()const selectReserveRecords = $grid.getCheckboxReserveRecords()VxeUI.modal.message({content: `总共勾选： ${selectRecords.length + selectReserveRecords.length} 条，当前页勾选：${selectRecords.length} 条，已保留勾选：${selectReserveRecords.length} 条`,status: 'success'})}
}handlePageData()
</script>

同时在其他分页中显示为半选状态

以上已经实现了分页状态保留功能，但是产品如果说还要在分页的同时，如果已选了其他页数据，当前页要显示半选状态，那么就可以通过以下来实现。

启用保留选中状态后默认是每页独立状态显示，可以通过 checkbox-config.showReserveStatus 启用，当存在保留记录时，则未勾选当前页数据也会显示未半选状态

<template><div><vxe-button status="success" @click="getSelectEvent">获取已选</vxe-button><vxe-grid ref="gridRef" v-bind="gridOptions" v-on="gridEvents"></vxe-grid></div>
</template><script setup>
import { ref, reactive } from 'vue'
import { VxeUI } from 'vxe-table'const gridRef = ref()const allList = [{ id: 10001, name: 'Test1', nickname: 'T1', role: 'Develop', sex: 'Man', age: 28, address: 'Shenzhen' },{ id: 10002, name: 'Test2', nickname: 'T2', role: 'Test', sex: 'Women', age: 22, address: 'Guangzhou' },{ id: 10003, name: 'Test3', nickname: 'T3', role: 'PM', sex: 'Man', age: 32, address: 'Shanghai' },{ id: 10004, name: 'Test4', nickname: 'T4', role: 'Designer', sex: 'Women', age: 23, address: 'test abc' },{ id: 10005, name: 'Test5', nickname: 'T5', role: 'Develop', sex: 'Women', age: 30, address: 'Shanghai' },{ id: 10006, name: 'Test6', nickname: 'T6', role: 'Designer', sex: 'Women', age: 21, address: 'Shenzhen' },{ id: 10007, name: 'Test7', nickname: 'T7', role: 'Test', sex: 'Man', age: 29, address: 'Shenzhen' },{ id: 10008, name: 'Test8', nickname: 'T8', role: 'Develop', sex: 'Man', age: 35, address: 'test abc' },{ id: 10009, name: 'Test9', nickname: 'T9', role: 'Develop', sex: 'Man', age: 35, address: 'Shenzhen' },{ id: 100010, name: 'Test10', nickname: 'T10', role: 'Develop', sex: 'Man', age: 35, address: 'Guangzhou' },{ id: 100011, name: 'Test11', nickname: 'T11', role: 'Develop', sex: 'Man', age: 49, address: 'Guangzhou' },{ id: 100012, name: 'Test12', nickname: 'T12', role: 'Develop', sex: 'Women', age: 45, address: 'Shanghai' },{ id: 100013, name: 'Test13', nickname: 'T13', role: 'Test', sex: 'Women', age: 35, address: 'Guangzhou' },{ id: 100014, name: 'Test14', nickname: 'T14', role: 'Test', sex: 'Man', age: 29, address: 'Shanghai' },{ id: 100015, name: 'Test15', nickname: 'T15', role: 'Develop', sex: 'Man', age: 39, address: 'Guangzhou' },{ id: 100016, name: 'Test16', nickname: 'T16', role: 'Test', sex: 'Women', age: 35, address: 'Guangzhou' },{ id: 100017, name: 'Test17', nickname: 'T17', role: 'Test', sex: 'Man', age: 39, address: 'Shanghai' },{ id: 100018, name: 'Test18', nickname: 'T18', role: 'Develop', sex: 'Man', age: 44, address: 'Guangzhou' },{ id: 100019, name: 'Test19', nickname: 'T19', role: 'Develop', sex: 'Man', age: 39, address: 'Guangzhou' },{ id: 100020, name: 'Test20', nickname: 'T20', role: 'Test', sex: 'Women', age: 35, address: 'Guangzhou' },{ id: 100021, name: 'Test21', nickname: 'T21', role: 'Test', sex: 'Man', age: 39, address: 'Shanghai' },{ id: 100022, name: 'Test22', nickname: 'T22', role: 'Develop', sex: 'Man', age: 44, address: 'Guangzhou' }
]const pagerVO = reactive({total: 0,currentPage: 1,pageSize: 10
})const gridOptions = reactive({showOverflow: true,border: true,loading: false,height: 500,rowConfig: {keyField: 'id'},checkboxConfig: {reserve: true,showReserveStatus: true},pagerConfig: pagerVO,columns: [{ type: 'checkbox', width: 60 },{ field: 'name', title: 'Name', minWidth: 160 },{ field: 'email', title: 'Email', minWidth: 160 },{ field: 'nickname', title: 'Nickname', minWidth: 160 },{ field: 'age', title: 'Age', width: 100 },{ field: 'role', title: 'Role', minWidth: 160 },{ field: 'amount', title: 'Amount', width: 140 },{ field: 'updateDate', title: 'Update Date', visible: false },{ field: 'createDate', title: 'Create Date', visible: false }],data: []
})// 模拟前端分页
const handlePageData = () => {gridOptions.loading = truesetTimeout(() => {const { pageSize, currentPage } = pagerVOpagerVO.total = allList.lengthgridOptions.data = allList.slice((currentPage - 1) * pageSize, currentPage * pageSize)gridOptions.loading = false}, 100)
}const gridEvents = {pageChange ({ pageSize, currentPage }) {pagerVO.currentPage = currentPagepagerVO.pageSize = pageSizehandlePageData()}
}const getSelectEvent = () => {const $grid = gridRef.valueif ($grid) {const selectRecords = $grid.getCheckboxRecords()const selectReserveRecords = $grid.getCheckboxReserveRecords()VxeUI.modal.message({content: `总共勾选： ${selectRecords.length + selectReserveRecords.length} 条，当前页勾选：${selectRecords.length} 条，已保留勾选：${selectReserveRecords.length} 条`,status: 'success'})}
}handlePageData()
</script>

https://gitee.com/x-extends/vxe-table

查看全文

http://www.jsqmd.com/news/170906/