fsLayui数据表格使用

fsLayui 是一个基于layui的快速开发插件,支持数据表格增删改查操作,提供通用的组件,通过配置html实现数据请求,减少前端js重复开发的工作。
GitHub下载 码云下载
测试环境地址:http://fslayui.itcto.cn

css和js引用

公共css和js必须全部引用

1
2
3
4
5
6
7
8
9
10
11
12
13
14
<!-- layui css -->
<link rel="stylesheet" type="text/css" href="/plugins/layui/css/layui.css" media="all"/>
<!-- 引入自定义css -->
<link rel="stylesheet" type="text/css" href="/css/fs.css" media="all"/>
<!-- layui js -->
<script type="text/javascript" src="/plugins/layui/layui.js"></script>
<!-- 引入jquery -->
<script type="text/javascript" src="/plugins/jquery/jquery.min.js"></script>
<!-- 引入数据字典 -->
<script type="text/javascript" src="/plugins/frame/js/fsDict.js?v=1.4.1"></script>
<!-- 引入 js入口文件 -->
<script type="text/javascript" src="/plugins/frame/js/fs.js?v=1.4.1"></script>
<!-- 引入通用数据表格框架js -->
<script type="text/javascript" src="/plugins/frame/js/frame.js?v=1.4.1"></script>

数据表格配置

datagrid配置

table标签 datagrid参数配置

datagrid demo

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
<table id="fsDatagrid" lay-filter="fsDatagrid" class="fsDatagrid" isLoad="1" url="/fsbus/1000" isPage="1" defaultForm="query_form" height="full-235"></table>
<div class="fsDatagridCols">
<p type="numbers" title="#"/>
<p checkbox="true"/>
<p field="id" title="ID" width="100" sort="true"/>
<p field="name" title="名称" width="30%" sort="true" />
<p field="type" title="类型" width="150" dict="type"/>
<p field="city" title="城市" width="100" dict="city"/>
<p field="sex" title="性别" width="100" />
<p field="state" title="状态" width="100" templet="#stateTpl"/>
<p field="area1" title="省份" width="100" dict="area1"/>
<p field="createdTime" title="创建时间" width="180"/>
<p field="modifiedTime" title="修改时间" width="180"/>
<p fixed="right" align="center" toolbar="#barDemo" title="操作" width="180"/>
</div>
<script type="text/html" id="stateTpl">
<input type="checkbox" name="state" lay-skin="switch" disabled lay-text="开启|关闭" {{ d.state == 1 ? 'checked' : '' }}>
</script>
<script type="text/html" id="barDemo">
<a class="layui-btn layui-btn-primary layui-btn-xs" lay-event="top" topUrl="edit.html" topMode="readonly" topWidth="800px" topHeight="600px" topTitle="查看demo" inputs="id:">查看</a>
<a class="layui-btn layui-btn-xs" lay-event="top" topUrl="edit.html" topWidth="800px" topHeight="600px" topTitle="编辑demo" inputs="id:">编辑</a>
<a class="layui-btn layui-btn-danger layui-btn-xs" lay-event="submit" url="/fsbus/1002" isConfirm="1" confirmMsg="是否确定删除当前记录?" inputs="id:">删除</a>
</script>

表格属性配置

表格数据请求配置,必须指定一个class样式fsDatagrididlay-filter必须一致。

1
<table id="fsDatagrid" lay-filter="fsDatagrid" class="fsDatagrid" url="/fsbus/1000" isPage="1" defaultForm="query_form" height="full-235"></table>
属性 必输 默认值 名称 描述
id 表格id 如果只有一个数据表格,id最好为 fsDatagrid
lay-filter 事件监听id 必须和表格id一致
class 样式 必须有 fsDatagrid 样式
url 请求地址 ajax异步提交地址
isPage 0 是否分页 1 分页,0 不分页
pageSize 20 每页数量 指定数据表格每页分页数量
defaultForm form表单id 表格查询的前置条件,配置后,默认把此form表单当做datagrid查询条件
height full-130 表格高度 表格高度
isLoad 1 是否自动加载 1 默认加载,0 不加载(配置为0后,表格默认填充空数据,点击刷新或者查询才会更新数据,一般在 联动表格 使用)
clickRenderTable 点击行渲染的表格id 点击表格行,渲染某个table( 联动表格 使用)
clickRenderTableInputs 点击后传入参数 自定义需要传入的参数( 联动表格 使用)

表格显示列配置

列配置,必须在table标签下方定义一个 div 标签,并且class为 fsDatagridCols
通过p标签,定义列的属性内容,参考layui官方配置:http://www.layui.com/doc/modules/table.html#cols

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<div class="fsDatagridCols">
<p type="numbers" title="#"/>
<p checkbox="true"/>
<p field="id" title="ID" width="100" sort="true"/>
<p field="name" title="名称" width="30%" sort="true" />
<p field="type" title="类型" width="150" dict="type"/>
<p field="city" title="城市" width="100" dict="city"/>
<p field="sex" title="性别" width="100" />
<p field="state" title="状态" width="100" templet="#stateTpl"/>
<p field="area1" title="省份" width="100" dict="area1"/>
<p field="createdTime" title="创建时间" width="180"/>
<p field="modifiedTime" title="修改时间" width="180"/>
<p fixed="right" align="center" toolbar="#barDemo" title="操作" width="180"/>
</div>
<script type="text/html" id="stateTpl">
<input type="checkbox" name="state" lay-skin="switch" disabled lay-text="开启|关闭" {{ d.state == 1 ? 'checked' : '' }}>
</script>

表格按钮设置

1
2
3
4
5
<script type="text/html" id="barDemo">
<a class="layui-btn layui-btn-primary layui-btn-xs" lay-event="top" topUrl="edit.html" topMode="readonly" topWidth="800px" topHeight="600px" topTitle="查看demo" inputs="id:">查看</a>
<a class="layui-btn layui-btn-xs" lay-event="top" topUrl="edit.html" topWidth="800px" topHeight="600px" topTitle="编辑demo" inputs="id:">编辑</a>
<a class="layui-btn layui-btn-danger layui-btn-xs" lay-event="submit" url="/fsbus/1002" isConfirm="1" confirmMsg="是否确定删除当前记录?" inputs="id:">删除</a>
</script>
属性 必输 默认值 名称 描述
lay-event 事件监听 top:弹出窗口;submit:提交数据
topUrl 弹出窗口地址 事件监听为top,此属性必输
topWidth 700px 弹出窗口宽度
topHeight 400px 弹出窗口高度
isMaximize 0 弹出窗口是否最大化 1:是, 0:否
topTitle 弹出窗口标题
topMode 弹出窗口模型 add:新增窗口,edit:编辑窗口,readonly:只读窗口; 新增、修改、查看共用同一个页面使用
url 提交请求地址 事件监听为submit,此属性必输
isConfirm 0 是否确认提示 1:是,0:否
confirmMsg 是否确定操作选中的数据? 确认提示内容
inputs 参数 自定义需要传入的参数

inputs参数说明
此属性主要为了传参

  1. 把当前选中的行id传入请求,可以配置 id:
  2. 传入固定的指,可以配置 属性:值 ,示例: state:1
  3. 传入的参数和选中的列参数不一样,可以配置 属性:$对应值的属性 ,示例:uid:$id
  4. 传入的参数取某一个输入框的值,可以配置 属性:#输入框id ,示例:name:#name
  5. 需要传多个参数直接通过 逗号 分割,示例: id:,state:1

form表单查询条件配置

只需要关注form表单id和查询按钮配置

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
<form class="layui-form" id="query_form">
<div class="layui-form-item">
<div class="layui-inline">
<label class="layui-form-mid">id:</label>
<div class="layui-input-inline" style="width: 100px;">
<input type="tel" name="id" autocomplete="off" class="layui-input"/>
</div>
</div>
<div class="layui-inline">
<label class="layui-form-mid">名称:</label>
<div class="layui-input-inline" style="width: 100px;">
<input type="text" name="name" autocomplete="off" class="layui-input"/>
</div>
</div>
<div class="layui-inline">
<label class="layui-form-mid">时间:</label>
<div class="layui-input-inline" style="">
<input type="text" name="createDate" autocomplete="off" class="layui-input fsDate" dateRange="1" placeholder=" - "/>
</div>
</div>
<div class="layui-inline">
<div class="layui-input-inline">
<button class="layui-btn" type="button" function="query" tableId="fsDatagrid"><i class="layui-icon">&#xe615;</i>查询</button>
</div>
</div>
</div>
</form>
  • 按钮属性
属性 必输 默认值 名称 描述
function 方法名称 查询写固定值 query
tableId fsDatagrid datagrid表格id 需要查询的datagrid表格id

表格菜单工具栏配置

通过菜单对datagrid表格增删改查操作

1
2
3
4
5
6
7
8
9
<button class="layui-btn" function="top" topUrl="add.html" topWidth="500px" topHeight="200px" topTitle="新增demo">
<i class="layui-icon">&#xe654;</i>新增
</button>
<button class="layui-btn layui-btn-danger" function="submit" url="/fsbus/1002" isSelect="1" isConfirm="1" confirmMsg="是否确定删除选中的数据?" inputs="id:">
<i class="layui-icon">&#xe640;</i>删除
</button>
<button class="layui-btn" function="refresh">
<i class="layui-icon">&#x1002;</i>刷新
</button>
  • 按钮属性
属性 必输 默认值 名称 描述
function 方法名称 top:弹出窗口,submit:提交数据,refresh:刷新表格,close:关闭窗口,query:查询
topUrl 弹出窗口地址 事件监听为top,此属性必输
topWidth 700px 弹出窗口宽度
topHeight 400px 弹出窗口高度
isMaximize 0 弹出窗口是否最大化 1:是, 0:否
topTitle 弹出窗口标题
topMode 弹出窗口模型 add:新增窗口,edit:编辑窗口,readonly:只读窗口; 新增、修改、查看共用同一个页面使用
url 提交请求地址 事件监听为submit,此属性必输
isSelect 是否单选 1:是,0:否
isMutiDml 是否多选 1:是,0:否
isConfirm 0 是否确认提示 1:是,0:否
confirmMsg 是否确定操作选中的数据? 确认提示内容
inputs 参数 自定义需要传入的参数
tableId fsDatagrid datagrid表格id 需要查询的datagrid表格id

inputs参数说明
此属性主要为了传参

  1. 把当前选中的行id传入请求,可以配置 id:
  2. 传入固定的指,可以配置 属性:值 ,示例: state:1
  3. 传入的参数和选中的列参数不一样,可以配置 属性:$对应值的属性 ,示例:uid:$id
  4. 传入的参数取某一个输入框的值,可以配置 属性:#输入框id ,示例:name:#name
  5. 需要传多个参数直接通过 逗号 分割,示例: id:,state:1