vben admin BasicTable 表格的进阶使用之带搜索区域

• 前言
• 一、上代码
• 二、上最终效果
• 三、代码分析
• • 1.创建实例
  • 2. 表格设置工具的配置
  • 2.使用 table 的插槽来放置按钮
  • 3.获取搜索区域表单的值
  • 4.实现在外部调用表单的 reload()
• 遗留思考
• 总结

前言

很久之前看了下关于 vben 的基础使用,最近项目需求开始用了,业务需要一个带搜索区域的表格,今天写完有点懵逼,来记录的过程中整理下思路~~

这里是之前写过的关于 vben admin BasicTable 表格的基本使用

一、上代码

二、上最终效果

三、代码分析

1.创建实例

我这里使用 useTable 的方式
如果需要开启搜索区域,在 useTable 的配置过程中需要加上下面的配置项

useSearchForm boolean false 使用搜索表单
formConfig any 表单配置，参考表单组件的 Props

2. 表格设置工具的配置

默认表格的设置区域的样式是这样子的,但是实际上并不需要这些,只保留一个刷新就可以了

配置项

showTableSetting	boolean	false	-	显示表格设置工具	
tableSetting	TableSetting	-	-	表格设置工具配置，见下方 TableSetting

2.使用 table 的插槽来放置按钮

这里使用了 basic table 的插槽来实现的

3.获取搜索区域表单的值

业务需求,在点击数据导出按钮的时候,执行 exportData() 函数需要发请求获取对应的文件 url 地址来实现下载功能
但是这个请求是需要带表格搜索区域的时间条件作为参数的,所以我需要获取到搜索表单中的数据
在官方文档中可以看到,table 的 methods 中是有 getForm() 的

在 exportData() 方法中,调用 getForm() 方法,获取到搜索表单实例对象
再调用 form 实例对象的getFieldsValue() 来获取数据

 let data = getForm().getFieldsValue();

  function exportData() {// getForm().resetFields()let data = getForm().getFieldsValue();exportTowerHistoryToExcel({ deviceId, createTime: data.startTime }).then((url) => {let fileName = url.slice(url.lastIndexOf('/') + 1);fetch(url).then((res) => res.blob()).then((blob) => {const link = document.createElement('a');link.href = URL.createObjectURL(blob);// 下载文件的名称及文件类型后缀link.download = fileName;document.body.appendChild(link);link.click();//在资源下载完成后 清除 占用的缓存资源window.URL.revokeObjectURL(link.href);document.body.removeChild(link);});});}

4.实现在外部调用表单的 reload()

业务表单需要在某些时机来刷新,而不是手动点击表单设置工具区域的刷新按钮,所以就需要表格实例对象的 reload() 方法

  const [registerTableA, { reload, getForm }] = useTable({.....});reload();

这样在需要刷新表单的时候执行 reload 就可以了

遗留思考

如果一个页面当中有多个表单实例的话 , emmm 分别需要在两个位置执行这两个表单的 reload()

如果出现下面的情况,怎样区分 是哪个表单的 relaod 呢?
(盲猜测以下代码会报错 毕竟出现了两个 reload 两个 getForm )

  const [registerTableA, { reload, getForm }] = useTable({.....});const [registerTableB, { reload, getForm }] = useTable({.....});

(继续猜测,没时间验证,等真的遇到可以试试看? 主要还是对 vue3 了解太差了)

  const [registerTableA, { reload as reloadA, getForm as getFormA }] = useTable({.....});const [registerTableB, { reload as reloadB, getForm  as getFormB }] = useTable({.....});reloadA();reloadB(); 

猜测失败

//直接编译失败了const [registerTableA, { reload as reloadA, getForm as getFormA }] = useTable({.....});const [registerTableB, { reload as reloadB, getForm  as getFormB }] = useTable({.....});reloadA();reloadB(); 

// reloadA is not definedconst [registerTableA, { reloadA :reload, getForm}] = useTable({.....});const [registerTableB, { reloadB :reload, getForm}] = useTable({.....});reloadA();reloadB(); 

总结

之前一直以为需要先通过给 table 或者 form 绑定 ref ,才能执行到 reload() , getFieldsValues() … 方法,但是实际上这种方式获取的好像是 DOM 对象,而不是实例对象