hzx97/vue-element-table

一款基于element-ui封装的基于JSON配置的表格，支持分页，按钮，行编辑等等功能

介绍

在开发管理系统的时候，经常会开发大量的表格，但是直接使用element-ui的原生组件时候，不仅写法繁琐，而且自身并不具备分页，行编辑，顶部按钮等等功能，需要通过插槽或者多个组件组合才能实现，本项目是基于element-ui二次封装的表格,具体功能点见下文。

我是子君，如果觉得这个框架有用，麻烦给我一个star,谢谢，同时欢迎您关注公众号【前端有的玩】，邀你一起玩前端

主要功能

1. 分页
2. 顶部按钮
3. 行编辑按钮
4. 自带复选框
5. 行编辑
6. 自适应高度
7. 链接列
8. 插槽列
9. 顶部按钮，行编辑按钮支持下拉按钮
10. 其他功能

具体功能见示例

待开发功能

1. 通过属性配置分页位置在顶部还是底部，或者顶部底部都显示
2. 可以支持更丰富的行编辑表单组件
3. 可以支持配置搜索功能
4. 支持滚动加载
5. 欢迎大家提 issues

常用命令

1. 安装

npm install vue-elementui-table -S

2. 在项目中使用

在main.js中添加以下代码

import ZjTable from 'vue-element-table'
Vue.use(ZjTable)

3. 查看官方示例

下载github源码，然后执行下面命令即可查看示例

npm run serve

4. 代码格式化

npm run lint

使用说明

点击访问 https://juejin.im/post/5f1d92cb5188252e884e986f，即可查看使用说明

API

表格属性

参数	说明	类型	默认值
columns	表格列,详见字段属性说明	Array<Object>	[]
buttons	表格上方的按钮，详见按钮字符说明	Array<Object>	[]
pagination	是否启用分页	Boolean	false
pageSize	分页后每页条数	Number	10
total	分页后数据总条数	Number	0
currentPage	分页后当前页码	Number	0
selectable	表格是否显示复选框	Boolean	true
sequence	表格前是否显示序号列	Boolean	false
height	表格高度,只有在特定情况下使用	`Number	String

表格事件

表格除了以下事件外，可以使用element ui 表格组件的其他所有事件

事件名	说明	参数
page-change	用户修改分页条数，页码等触发	-
selection-change	用户修改复选框选中的行时触发	selection: 选中的行数据
current-change	用户点击行时触发	current: 点击的行数据
sort-change	在启用表头排序后排序状态发生变化触发	-

表格方法

方法名	说明	参数	返回值
startEditRow	开始行编辑	index: 编辑的行索引	-
endEditRow	结束行编辑	callback(valid, data, rows): 回调函数， valid: 行编辑验证是否成功 data: 验证成功行编辑数据，失败时为失败原因 rows: 编辑的这一行的原始数据	-
isEditRow	当前表格是否正在行编辑	-	result:Boolean
cancelEditRow	取消行编辑	-	-
getSelectionRows	获取复选框选中的行	-	rows:Array<row>
getCurrentRow	获取点击行选中的行	-	row:Object
setCurrentRow	单行选中时设置选中的行	row:Object	-
getEditFieldValues	获取正在编辑的行的数据	-	data:Object
setEditFieldValues	设置正在编辑行的数据	data:Object	-
toggleRowSelection	启用复选后切换行的选中状态	row: Object, select: Boolean	-
doLayout	重新布局表格,当表格父容器由隐藏状态变为显示时，可能表格布局会错乱	-	-

内置插槽

插槽	说明	参数
column	表格列插槽，可以自定义表格列渲染方式	{row,column,prop,cellValue,$index,field} field为行编辑字段信息
header	自定义表格表头显示方式	{label,prop,column, $index, field }
button	自定义表头顶部按钮	{button, selectedRow} selectedRow为选中的表格行数据
toolbar	自定义顶部工具条, 工具条会放在左侧按钮与右侧搜索区域中间	-

列属性

列属性除以下属性外，elementui 列其他属性均可使用

参数	说明	类型	默认值
label	列名	String	-
prop	列属性	String	-
width	表头宽度	Number	-
sortable	是否排序列	Boolean	false
formatter	单个元格式化	(row,column,cellValue):String	-
nests	嵌套列	Array<Column>	-
events	单元格事件，见elementui单元格事件	Object<Event>	-
actions	操作列，详见操作列属性	Array<Object>	-
editable	是否可编辑行	Boolean	false
field	行编辑字符，详见行编辑字段属性	Object	-
beforeEdit	当前单元格开启编辑时调用，返回true则开启编辑	(row,column,cellValue,index):Boolean
useSlot	是否在当前列使用插槽，插槽名称为 column	Boolean	false
hidden	是否隐藏当前列	`Boolean	Function`

表头按钮属性

表头按钮除以下属性外，elementui 按钮其他属性均可使用

参数	说明	类型	默认值
id	按钮唯一标识，必填	`String	Number`
text	按钮显示文字	String	-
icon	按钮显示图标	String	-
click	点击按钮事件,传入选中的行数据	(rows):void	-

行操作按钮属性

参数	说明	类型	默认值
id	按钮唯一标识，必填	`String	Number`
text	按钮冒泡显示的文字	String	-
icon	按钮图标，必填	String	-
before	按钮渲染前调用，返回false不渲染按钮	(row,column,index):Boolean	-
click	点击按钮事件	(row,column,index):void	-