使表格增加了树形结构展示的能力.完全依赖于layui的表格. 正因为如此,您可以像使用表格组件一样使用该组件.layui的表格功能.全都有.全都有.全都有. 该组件最大的特点就是原封不动的调用了官方的table组件.也就是说.随着官方的更新.可以随时使用table更好更炫酷的功能而不需要对本组件做任何操作.
方法名 | 描述 |
---|---|
render | 表格渲染.一般第一次显示调用.或者其他操作比如删除/添加等操作后也可以调用.第二次调用可以不传参数.如果传递参数会将上次参数覆盖. |
reload | 表格重载,内部调用了table.reload().一般用于搜索后显示数据.提交where条件给后端. |
getTable | 由于该组件内部使用了layui.table.如果想更细粒度的操作table.可以使用此方法获取table对象 |
其他方法 | 请阅读源码,只要方法名不以下划线开头都可以使用.如果需要的话. |
名称 | 描述 | 必填 | 默认值 |
---|---|---|---|
keyId | 数据ID的字段.一般对应数据库的主键.默认: 'id' | false | id |
keyPid | 数据父ID,与父级数据的ID相等.此参数与ID确定上下级关系. | false | pid |
title | 泛指数据标题,来自列(cols)的field属性.表明此字段在被点击时候会展开/折叠下级. | false | name |
indent | 缩进字符.在此设置的字符会添加到title列前面.次数为层级的值.效果就是层级越靠下.缩进的越多. | false | ' ' |
icon | 标题前面的小图标. 在展开时候显示的样式使用icon.open设置, 折叠时候使用icon.close. 值是css的一个class属性字符串.该字符串可以包含多个类. |
false | 展开: layui-icon layui-icon-triangle-d 折叠: layui-icon layui-icon-triangle-r |
showCache | 这里就要好好说说了.该字段表示数据展开折叠缓存.刷新时候可以保留上次的展开状态 a).如果传false表示不使用缓存.此时渲染完成的状态为全部折叠; b).如果传true.会把操作过程中的展开折叠状态记录到 localStorage 中.key为 unfoldStatus; c).可以传一个字符串.这时候与传true类似,区别是 localStorage 的 key 为传入的字符串.建议传字符串.可以有效避免多个页面之间的冲突. |
false | unfoldStatus |
sort | 排序方式,可选值为 asc / desc, 默认 asc.必须小写.会影响所有层级. | false | asc |
layui.use(['tableTreeDj'], function() {
const tableTree = layui.tableTreeDj;
const $ = layui.$;
// 与 layui.table 的参数完全一致,内部本来就是把这些参数传递给table模块的
const objTable = {
elem: '#test'
,url: "./getData"
,cols: [[
{field:'name', title:'名称' },
{field:'id', title:'ID' },
{field:'pid', title:'上级ID' },
{field:'level', title:'层级' },
{field:'agent_id', title:'代理ID' },
]]
,id:'list'
}
// 本组件用到的参数, 组件内部有默认值,与此一致,因此您可以只声明不一致的配置项
const config = {
keyId: "id" // 当前ID
, keyPid: "pid" // 上级ID
, title: "name" // 标题名称字段,此字段td用于绑定单击折叠展开功能
, indent: ' ' // 子级td的缩进.可以是其他字符
// 图标
, icon: {
open: 'layui-icon layui-icon-triangle-d', // 展开时候图标
close: 'layui-icon layui-icon-triangle-r', // 折叠时候图标
}
, showCache: true //是否开启展开折叠缓存,默认不开启.
, sort: 'asc'
};
// 渲染
tableTree.render(objTable, config);
// 其他一系列操作后.重新渲染表格,此时可以不传递参数.内部记录了上次传入的参数.
tableTree.render();
// 点击搜索按钮后重载数据.此时可以传入where条件.obj参数与官方表格一致.
obj = {where:{id: 1}};
tableTree.reload(obj);
});