基于Ant Design Vue 封装useTable hooks
zhezhongyun 2025-05-11 19:39 23 浏览
在项目开发中经常会使用Table,我们用的antd或者element等前端UI框架中的Table组件需要传递一些参数,比如tableData、pagination、tableData还有就是一些查询的方法和参数,每次使用都要重新声明就很繁琐,所以现在就来封装一个Vue3中的useTable。
1. 新建hooks useTable.ts 文件
// useTable.ts
import { ref, toRefs, reactive, computed, nextTick } from 'vue'
// 国际化
import { $t } from '@/i18n'
export default function useTable(options?: Record<string, any>) {
const loading = ref<boolean>(false)
const dataObj = reactive({
selectedRowKeys: <any>[], // 选中的数据的key
selectedRows: <any>[] // 选中的数据
})
const pagination = reactive({
current: 1,
pageSize: options?.pageSize ?? 30,
showSizeChanger: options?.showSizeChanger ?? true, // 用于控制展示每页多少条的下拉
showQuickJumper: options?.showQuickJumper ?? false,
total: 0,
pageSizeOptions: options?.pageSizeOptions ?? ['10', '20', '30', '40', '50', '100'],
showTotal: (total: number) => `${$t('total')} ${total} ${$t('pieces')}`,
onShowSizeChange: pageSizeChange,
onChange: pageChange
})
// 页数改变的方法
function pageSizeChange(_val: number, pageNum: number) {
pagination.pageSize = pageNum // 修改每页显示的条数
pagination.current = 1
}
// 点击上一页下一页的方法
function pageChange(page: number) {
pagination.current = page
}
// 选中处理
const rowSelection = computed(() => (type: string = 'radio') => {
const { selectedRowKeys } = dataObj
return {
preserveSelectedRowKeys: true, // 跨页选中
type: type, // 单选/复选 默认单选
columnWidth: 80,
columnTitle: type === 'radio' ? $t('columns.selection') : '',
selectedRowKeys, // 取消选中(必须加上不然无效)
onChange: (selectedRowKeys: (string | number)[], selectedRows: any[]) => {
dataObj.selectedRowKeys = selectedRowKeys
dataObj.selectedRows = selectedRows
}
}
})
// 取消表格选中方法
const clearTableSelected = () => {
dataObj.selectedRowKeys = []
dataObj.selectedRows = []
}
return {
...toRefs(dataObj),
pagination,
loading,
rowSelection,
clearTableSelected
}
}
2. 改造 useTable hooks 让表格高度可以自适应
// useTable.ts
import { ref, toRefs, reactive, computed, onMounted, nextTick } from 'vue'
// 国际化
import { $t } from '@/i18n'
/**
* 获取第一个表格的可视化高度
* @param {*} extraHeight 额外的高度(表格底部的内容高度 Number类型,默认为74)
* @param {*} id 当前页面中有多个table时需要制定table的id
*/
const getTableScroll = (extraHeight?: number, id?: any) => {
extraHeight = extraHeight || 64
let tHeader = null
if (id) {
const tableDom = document.getElementById(id)
tHeader = tableDom ? tableDom.getElementsByClassName('ant-table-thead')[0] : null
} else {
tHeader = document.getElementsByClassName('ant-table-thead')[0]
}
//表格内容距离顶部的距离
let tHeaderBottom = 0
if (tHeader) {
tHeaderBottom = tHeader.getBoundingClientRect().bottom
}
//窗体高度-表格内容顶部的高度-表格内容底部的高度
const height = `calc(100vh - ${tHeaderBottom + extraHeight}px)`
return height
}
/*
options object属性 根据需求添加参数 目前有以下参数:
@params pageSize number类型,自定义表格每页显示条数
@params showSizeChanger boolean类型,自定义控制是否展示每页多少条的下拉空间
@params showQuickJumper boolean类型,自定义控制是否展示跳转空间
@params pageSizeOptions array类型,自定义表格size下拉选项
@params disabledField string类型,可选中表格时不可选中的判断字段名称 该字段的值必须是true或者false
@params tableKey string类型,表格全系统唯一标识
@params extraHeight number类型,表格底部留白的额外高度
@params delay number类型,表格随窗口变化高度重新计算的延迟时间毫秒
用法示例:usetable({})作为参数传入
*/
export default function useTable(options?: Record<string, any>) {
const loading = ref<boolean>(false)
const scrollY = ref('')
const dataObj = reactive({
selectedRowKeys: <any>[],
selectedRows: <any>[]
})
const pagination = reactive({
current: 1,
pageSize: options?.pageSize ?? 30,
showSizeChanger: options?.showSizeChanger ?? true, // 用于控制展示每页多少条的下拉
showQuickJumper: options?.showQuickJumper ?? false,
total: 0,
pageSizeOptions: options?.pageSizeOptions ?? ['10', '20', '30', '40', '50', '100'],
showTotal: (total: number) => `${$t('total')} ${total} ${$t('pieces')}`,
onShowSizeChange: pageSizeChange,
onChange: pageChange
})
// 页数改变的方法
function pageSizeChange(_val: number, pageNum: number) {
pagination.pageSize = pageNum // 修改每页显示的条数
pagination.current = 1
}
// 点击上一页下一页的方法
function pageChange(page: number) {
pagination.current = page
}
// 选中处理
const rowSelection = computed(() => (type: string = 'radio') => {
const { selectedRowKeys } = dataObj
return {
preserveSelectedRowKeys: true, // 跨页选中
type: type,
columnWidth: 80,
columnTitle: type === 'radio' ? $t('columns.selection') : '',
selectedRowKeys, // 取消选中(必须加上不然无效)
onChange: (selectedRowKeys: (string | number)[], selectedRows: any[]) => {
dataObj.selectedRowKeys = selectedRowKeys
dataObj.selectedRows = selectedRows
},
getCheckboxProps: (record: any) => {
// disabledField接搜不可选中字段
if (options?.disabledField) {
return {
disabled: record[options.disabledField]
}
}
return {
disabled: false
}
}
}
})
// 取消表格选中方法
const clearTableSelected = () => {
dataObj.selectedRowKeys = []
dataObj.selectedRows = []
}
onMounted(() => {
nextTick(() => {
scrollY.value = getTableScroll(options?.extraHeight ?? 0, options?.tableKey ?? '')
window.onresize = debounce(() => {
scrollY.value = getTableScroll(options?.extraHeight ?? 0, options?.tableKey ?? '')
}, options?.delay ?? 50)
})
})
return {
...toRefs(dataObj),
pagination,
loading,
scrollY,
rowSelection,
clearTableSelected
}
}
3. 在 index.vue 文件中使用 useTable hooks
<!-- index.vue -->
<template>
<a-table
bordered
:row-selection="rowSelection()"
:columns="columns"
:row-key="(record: any) => record.id"
:data-source="dataSource"
:pagination="pagination"
:loading="loading"
:scroll="{ y: scrollY}"
@change="handleTableChange"
>
</a-table>
</template>
<script setup lang="ts">
import { computed, watch, reactive, ref } from 'vue'
import useTable from '@/hooks/useTable'
const { pagination, selectedRowKeys, selectedRows, rowSelection, clearTableSelected,scrollY } = useTable()
</script>
rowSelection()不传任何参数默认单选,rowSelection('checkbox')时多选
相关推荐
- 一篇文章带你了解SVG 渐变知识(svg动画效果)
-
渐变是一种从一种颜色到另一种颜色的平滑过渡。另外,可以把多个颜色的过渡应用到同一个元素上。SVG渐变主要有两种类型:(Linear,Radial)。一、SVG线性渐变<linearGradie...
- Vue3 实战指南:15 个高效组件开发技巧解析
-
Vue.js作为一款流行的JavaScript框架,在前端开发领域占据着重要地位。Vue3的发布,更是带来了诸多令人兴奋的新特性和改进,让开发者能够更高效地构建应用程序。今天,我们就来深入探讨...
- CSS渲染性能优化(低阻抗喷油器阻值一般为多少欧)
-
在当今快节奏的互联网环境中,网页加载速度直接影响用户体验和业务转化率。页面加载时间每增加100毫秒,就会导致显著的流量和收入损失。作为前端开发的重要组成部分,CSS的渲染性能优化不容忽视。为什么CSS...
- 前端面试题-Vue 项目中,你做过哪些性能优化?
-
在Vue项目中,以下是我在生产环境中实践过且用户反馈较好的性能优化方案,整理为分类要点:一、代码层面优化1.代码分割与懒加载路由懒加载:使用`()=>import()`动态导入组件,结...
- 如何通过JavaScript判断Web页面按钮是否置灰?
-
在JavaScript语言中判断Web页面按钮是否置灰(禁用状态),可以通过以下几种方式实现,其具体情形取决于按钮的禁用方式(原生disabled属性或CSS样式控制):一、检查原生dis...
- 「图片显示移植-1」 尝试用opengl/GLFW显示图片
-
GLFW【https://www.glfw.org】调用了opengl来做图形的显示。我最近需要用opengl来显示图像,不能使用opencv等库。看了一个glfw的官网,里面有github:http...
- 大模型实战:Flask+H5三件套实现大模型基础聊天界面
-
本文使用Flask和H5三件套(HTML+JS+CSS)实现大模型聊天应用的基本方式话不多说,先贴上实现效果:流式输出:思考输出:聊天界面模型设置:模型设置会话切换:前言大模型的聊天应用从功能...
- ae基础知识(二)(ae必学知识)
-
hi,大家好,我今天要给大家继续分享的还是ae的基础知识,今天主要分享的就是关于ae的路径文字制作步骤(时间关系没有截图)、动态文字的制作知识、以及ae特效的扭曲的一些基本操作。最后再次复习一下ae的...
- YSLOW性能测试前端调优23大规则(二十一)---避免过滤器
-
AlphalmageLoader过滤器是IE浏览器专有的一个关于图片的属性,主要是为了解决半透明真彩色的PNG显示问题。AlphalmageLoader的语法如下:filter:progid:DX...
- Chrome浏览器的渲染流程详解(chrome预览)
-
我们来详细介绍一下浏览器的**渲染流程**。渲染流程是浏览器将从网络获取到的HTML、CSS和JavaScript文件,最终转化为用户屏幕上可见的、可交互的像素画面的过程。它是一个复杂但高度优...
- 在 WordPress 中如何设置背景色透明度?
-
最近开始写一些WordPress专业的知识,阅读数奇低,然后我发一些微信昵称技巧,又说我天天发这些小学生爱玩的玩意,写点文章真不容易。那我两天发点专业的东西,两天发点小学生的东西,剩下三天我看着办...
- manim 数学动画之旅--图形样式(数学图形绘制)
-
manim绘制图形时,除了上一节提到的那些必需的参数,还有一些可选的参数,这些参数可以控制图形显示的样式。绘制各类基本图形(点,线,圆,多边形等)时,每个图形都有自己的默认的样式,比如上一节的图形,...
- Web页面如此耗电!到了某种程度,会是大损失
-
现在用户上网大多使用移动设备或者笔记本电脑。对这两者来说,电池寿命都很重要。在这篇文章里,我们将讨论影响电池寿命的因素,以及作为一个web开发者,我们如何让网页耗电更少,以便用户有更多时间来关注我们的...
- 11.mxGraph的mxCell和Styles样式(graph style)
-
3.1.3mxCell[翻译]mxCell是顶点和边的单元对象。mxCell复制了模型中可用的许多功能。使用上的关键区别是,使用模型方法会创建适当的事件通知和撤销,而使用单元进行更改时没有更改记...
- 按钮重复点击:这“简单”问题,为何难住大半面试者与开发者?
-
在前端开发中,按钮重复点击是一个看似不起眼,实则非常普遍且容易引发线上事故的问题。想象一下:提交表单时,因为网络卡顿或手抖,重复点击导致后端创建了多条冗余数据…这些场景不仅影响用户体验,更可能造成实...
- 一周热门
- 最近发表
- 标签列表
-
- HTML 教程 (33)
- HTML 简介 (35)
- HTML 实例/测验 (32)
- HTML 测验 (32)
- JavaScript 和 HTML DOM 参考手册 (32)
- HTML 拓展阅读 (30)
- HTML文本框样式 (31)
- HTML滚动条样式 (34)
- HTML5 浏览器支持 (33)
- HTML5 新元素 (33)
- HTML5 WebSocket (30)
- HTML5 代码规范 (32)
- HTML5 标签 (717)
- HTML5 标签 (已废弃) (75)
- HTML5电子书 (32)
- HTML5开发工具 (34)
- HTML5小游戏源码 (34)
- HTML5模板下载 (30)
- HTTP 状态消息 (33)
- HTTP 方法:GET 对比 POST (33)
- 键盘快捷键 (35)
- 标签 (226)
- HTML button formtarget 属性 (30)
- CSS 水平对齐 (Horizontal Align) (30)
- opacity 属性 (32)