Skip to content

table 表格组件

示例中提到的配置都在 tableConfig 中配置

columns 列

该示例展示所有类型的表格列配置

配置 columns 属性,

el-table 属性和方法设置

该示例展示了如何设置表格原有的属性方法用法

可以通过配置 propAttrscolumns 子项的 propAttrs属性,,具体属性方法可查看 el-table 组件的文档。

生命周期

该示例展示页面请求数据过程中的钩子函数

paramsFormat 数据请求前,可以对请求参数做一些格式处理。
responseFormat 数据请求后,可以对请求成功后接口返回数据做一些格式处理. 该组件需要格式为: { code: 1, data: { list: [], total: 0 } },如果接口返回的格式不是该格式需要使用该函数处理返回值。
formDataFormat 点击 编辑/复制时的回调函数,可以对该条数据做一些格式处理或请求接口。

选择列配置

该示例展示表格多选功能

设置hasSelection 为 true, 表示显示表格的选择列,也支持函数,设置selectable用来决定这一行的 CheckBox 是否可以勾选。

顶部操作按钮配置

该示例展示了表格顶部操作按钮的配置

通过配置 headerOperation 属性,来控制添加,删除,导入,返回按钮的显示隐藏, 支持函数或 boolean 类型, 该示例使用的函数。
其中返回按钮用于子页面中配合 backCb 一起使用,导入按钮需配合 importConfig 配置使用。删除按钮需要配合deleteConfig配置使用
可以通过设置 headerOperation 下的addBtnText,deleteBtnText, importBtnText来控制按钮的文字 可以通过 headerOperations-before, headerOperations 插槽自定义按钮, 自定义按钮需加上 xb-table-operation-btn

表格操作按钮配置

该示例展示了表格操作按钮的配置

通过配置operationConfig 属性,来控制编辑,删除,复制按钮的显示隐藏, 支持函数或 boolean 类型, 该示例使用的函数。
可以配置 operationConfig.width 来控制操作栏的宽度。
可以通过 tableOperations, headerOperations-after 插槽自定义按钮, 自定义按钮需加上 xb-operation-btn

底部工具栏配置

该示例展示了表格底部工具栏的配置

该配置目前只能控制底部栏的显示隐藏,支持函数或 boolean 类型, 该示例使用的函数。
通过 table-tool 插槽自定义右侧工具按钮

导入配置

该示例展示了表格导入功能的配置

当 设置 headerConfig.hasImport 为 true 时,通过配置 importConfig 属性,实现导入功能

删除功能配置

该示例展示了表格删除功能的配置

通过配置deleteConfig 属性,实现删除功能

API

属性说明Type默认值
name页面的名称, 用于表格上部按钮添加,删除的名称string-
tableConfig表格配置, 详细 tableConfig 配置Object-

tableConfig

属性说明Type默认值
propAttrs表格属性, 详细见 el-table 属性object{
  height: 100%
}
requestParams表格请求额外请求参数, 如果 key 为 pageSize, page,会覆盖默认的 page,pageSizeObject-
hasSelection是否显示表格的选择列,boolean/functiontrue
requestApi请求表格数据的方法, 返回值要求 promisefunction-
paramsFormat格式化请求参数function(val)-
responseFormat格式化请求返回的表格数据function(val)-
formDataFormat表单值格式化用于编辑/复制,支持接口, 只在使用 curdTable 时有效,通过 resolve(newFormData) 返回新值function(resolve, data, formData)-
selectable用来决定这一行的 CheckBox 是否可以勾选function(row, index)-
columns表格列配置, 详见 columns 配置array-
headerConfig表格上方操作区域配置, 详见 headerConfig 配置object-
importConfig表格数据导入功能配置, 详见 importConfig 配置object-
operationConfig表格最后一列操作按钮的配置, 详见 operationConfig 配置object-
deleteConfig删除功能的配置, 详见 deleteConfig 配置object-
footerConfig底部功能区配置,目前只支持是否显示, 支付函数/booleanObject{
   show: true
}

columns 列

属性说明Type默认值
prop列的键值, 即列表接口返回的 key, 为必填项string-
label列的名称string-
show是否显示列boolean-
showHeader是否使用自定义表头booleanfalse
contentType列的类型, 可选值为 template(自定义) 详见:Slots 插槽 / sort(排序)string-
propAttrs列的属性, 详见el-table 的列属性Object-
sortConfigcontentType 为 sort 时有效,详见 sortConfig 配置object-

headerConfig 表格上方操作区配置

属性说明Type默认值
show是否显示表格上方操作区域, 支持函数和booleanboolean/functiontrue
hasAdd是否显示添加按钮, 支持函数和booleanboolean/functiontrue
addBtnText编辑按钮文字string-
hasCopy是否显示复制按钮, 支持函数和booleanboolean/functiontrue
hasDelete是否显示删除按钮, 支持函数和booleanboolean/functiontrue
deleteBtnText删除按钮文字string-
hasImport是否显示导入按钮 ,支持函数和booleanboolean/functionfalse
hasBack是否显示返回按钮, 用于二级子页面返回主页面, 支持函数和booleanboolean/functionfalse
backCb返回按钮回调函数, 当 hasBack 为 true 时使用function-

importConfig 导入功能配置

属性说明Type默认值
requestApi导入请求接口的方法, 返回值要求 promise,function
fileKey文件上传参数的 key 值stringfile
paramsFormat格式化请求参, 接收参数data为上传的数据, 需 return 完整的 FormData 数据function(data)-
responseFormat格式化返回值function-
propAttrsel-upload 上传组件的属性方法设置object-

operationConfig 表格操作列配置-

属性说明Type默认值
show是否显示表格操作列booleantrue
hasDelete是否显示删除按钮,如果是函数时,结束 data 参数(该条数据),需 return true 或 false,boolean/function-
hasEdit是否显示编辑按钮, 如果是函数时 同上boolean/function-
hasCopy是否显示复制按钮, 如果是函数时 同上boolean/function-
width操作列宽度string/ref100

deleteConfig 删除功能配置

属性说明Type默认值
deleteItemIdKey删除参数值在表格数据对应的 keystringid
deleteIdKey删除参数的 keystringids
responseFormat格式化返回值string-
paramsFormat格式化参数string-

sortConfig 列表排序功能配置

属性说明Type默认值
requestApi排序请求接口的方法function-
prop列表排序的字段stringsort
responseFormat格式化返回值string-
paramsFormat格式化参数string-

Slots 插槽

插槽名说明
columns 的 prop 值当 content 为 template 时,自定义内容, 值:scope(数据)
columns 的 prop 值 + Header当 showHeader 为 true 时,自定义表头内容
tableOperations表格操作栏按钮 , 值: tableRef(表格实例), data(数据), refresh(刷新表格), index(索引)
headerOperations表格顶部操作按钮, 值: tableRef(表格实例), refresh(刷新表格)
empty表格空数据时显示的内容
table-tool底部右边操作按钮