layui/docs/treeTable/detail/options.md
贤心 169f6ff9b8
feat: 重构 laytpl,增强对更多复杂模板结构的解析能力 (#2577)
* feat: 重构 laytpl,增强对更多复杂模板结构的解析能力

* Squashed commit of the following:

commit 6884f80378
Author: 贤心 <3277200+sentsim@users.noreply.github.com>
Date:   Wed Mar 19 14:45:58 2025 +0800

    release: v2.10.1

commit 8d643ad6dc
Merge: 5521e48c 213fe5a2
Author: corededitor <107152508+corededitor@users.noreply.github.com>
Date:   Wed Mar 19 14:24:50 2025 +0800

    feat: Merge pull request #2566 from layui/feat/component

    feat: 优化 component, tabs 若干功能

commit 213fe5a209
Author: 贤心 <3277200+sentsim@users.noreply.github.com>
Date:   Wed Mar 19 14:15:39 2025 +0800

    docs: 添加 component 文档中实验性选项标记

commit 5521e48c05
Author: 贤心 <3277200+sentsim@users.noreply.github.com>
Date:   Wed Mar 19 14:10:46 2025 +0800

    fix: 修复 `body` 初始 `line-height` 无效的问题 (#2569)

commit 8c7cf0f606
Author: 青崖 <33601030+bxjt123@users.noreply.github.com>
Date:   Wed Mar 19 14:10:08 2025 +0800

    优化 checkbox 标签风格选中且禁用时的显示 (#2563)

commit 23b21254d4
Author: 贤心 <3277200+sentsim@users.noreply.github.com>
Date:   Wed Mar 19 14:04:44 2025 +0800

    docs: Squashed commit of the following:

    commit 95a0503f41
    Merge: e6eb86ba 87ba4c43
    Author: 贤心 <3277200+sentsim@users.noreply.github.com>
    Date:   Wed Mar 19 14:03:13 2025 +0800

        Merge branch 'main' into 2.x

    commit e6eb86bacb
    Author: morning-star <26325820+Sight-wcg@users.noreply.github.com>
    Date:   Wed Mar 19 14:02:05 2025 +0800

        docs(slider): 修正错别字 (#2578)

    commit 46f7a9783e
    Merge: df1fc4f4 c204590a
    Author: 贤心 <3277200+sentsim@users.noreply.github.com>
    Date:   Fri Mar 14 19:07:50 2025 +0800

        Merge branch 'main' into 2.x

    commit df1fc4f419
    Author: itletu <itletu@163.com>
    Date:   Mon Mar 10 13:54:06 2025 +0800

        docs: 更正 class 公共类文档错误 (#2544)

        | layui-border-box | 设置元素及其所有子元素均为 `box-sizing: border-box` 模型的容器 |

commit 87ba4c4394
Author: 贤心 <3277200+sentsim@users.noreply.github.com>
Date:   Wed Mar 19 13:41:33 2025 +0800

    docs(version): 优化 2.9.x 锚点

commit a0f533f0fd
Author: 贤心 <3277200+sentsim@users.noreply.github.com>
Date:   Wed Mar 19 13:37:29 2025 +0800

    docs: 修复 tabs 文档示例异常问题

commit 0f0584e2ed
Author: 贤心 <3277200+sentsim@users.noreply.github.com>
Date:   Wed Mar 19 13:35:00 2025 +0800

    docs: 修复 tabs 文档中自定义事件示例重新点击 Preview 失效的问题

commit 172957d243
Author: 贤心 <3277200+sentsim@users.noreply.github.com>
Date:   Wed Mar 19 13:29:09 2025 +0800

    docs: 优化文档中的用词细节 (#2571)

commit 094be4ddcc
Author: letianpailove <113023596+letianpailove@users.noreply.github.com>
Date:   Wed Mar 19 13:28:46 2025 +0800

    fix: 更正 class 公共类文档错误 (#2562)

commit 53ded26cb9
Author: 贤心 <3277200+sentsim@users.noreply.github.com>
Date:   Sun Mar 16 00:15:25 2025 +0800

    fix: 优化 tabs 重载时未按照传入的 closable 正确渲染可关闭状态

commit bd892bf87e
Author: 贤心 <3277200+sentsim@users.noreply.github.com>
Date:   Sun Mar 16 00:15:17 2025 +0800

    feat(component): 新增 cache 原型方法,用于元素缓存操作

commit 6ccc5a453d
Author: 贤心 <3277200+sentsim@users.noreply.github.com>
Date:   Sun Mar 16 00:14:18 2025 +0800

    fix(component): 优化元素 lay-options 属性上的配置在重载时的优先级

commit 79b0a56f50
Author: 贤心 <3277200+sentsim@users.noreply.github.com>
Date:   Sun Mar 16 00:13:55 2025 +0800

    fix(component): 修复 reload 时传入的选项未正确合并的问题

* refactor(laytpl): 优化代码细节

* docs: 重写 laytpl 模块文档
2025-03-27 23:55:04 +08:00

6.1 KiB
Raw Blame History

属性名 描述
tree

treeTable 组件的特定属性集,包含以下「子成员集」:

属性 描述
customName 自定义属性名的集合
view 视图相关的属性集合
data 数据相关的属性集合
async 异步相关的属性集合
callback 事件回调相关的属性集合

用法如下:

treeTable.render({
  elem: '',
  tree: { // treeTable 特定属性集
    customName: {},
    data: {},
    view: {},
    async: {},
    callback: {}
  },
  // 其他 table 属性
});
tree.customName

自定义属性名的集合,包含以下成员:

属性 描述 类型 默认值
children 自定义「子节点集合」的属性名 string children
isParent 自定义「是否属于父节点」的属性名 string isParent
name 自定义「节点」属性名 string name
id 自定义「节点索引」属性名 string id
pid 自定义「父节点索引」属性名 string parentId
icon 自定义图标的属性名称 string icon
tree.view

视图相关的属性集合,包含以下成员:

属性 描述 类型 默认值
indent 层级缩进量 number 14
flexIconClose 自定义关闭时的折叠按钮图标 string -
flexIconOpen 自定义打开时的折叠按钮图标 string -
showIcon 是否显示节点图标 boolean true
icon 自定义节点图标。若设置了该属性或数据中有该字段信息,不管打开还是关闭都以这个图标的值为准 string -
iconClose 自定义关闭时的节点图标 string -
iconOpen 自定义打开时的节点图标 string -
iconLeaf 自定义叶子节点的图标 string -
showFlexIconIfNotParent 若非父节点时,是否显示折叠图标 boolean false
dblClickExpand 双击节点时,是否自动展开父节点 boolean true
expandAllDefault 2.8.7+ 是否默认展开全部节点 boolean false

自定义图标支持 HTML 字符串和图标类名。例如:

  • '<i class="i-svg-spinners-blocks-wave"></i>'
  • 'layui-icon layui-icon-addition'
tree.data

数据相关的属性集合,包含以下成员:

属性 描述 类型 默认值
isSimpleData 是否使用平铺数据格式(Array) boolean false
rootPid 用于设置根节点的 pid 属性值 string null
cascade 用于设置复选的级联方式。支持以下可选值:
  • all : 所有节点联动
  • parent : 仅对父节点联动
  • children : 仅对子节点联动
  • none 2.8.16+ : 不做任何联动
string all
tree.async

异步相关的属性集合,包含以下成员:

属性 描述 类型 默认值
enable 是否开启异步加载模式。只有开启时 async 的其他属性选项才有效。 注意: 异步加载子节点不应跟 simpleData 同时开启,可以是 url+simpleData 的方式,获取完整的简单数据进行转换。若开启异步加载模式,即表示按需异步加载子节点。 boolean false
url 异步加载的接口,可以根据需要设置与顶层接口不同的接口,若相同可不设置该属性 string -
format 用于处理异步子节点数据的回调函数,该属性优先级高于 async.url 属性。用法详见下文。 function -
type 请求的接口类型,设置可缺省同上 string -
contentType 提交参数的数据类型,设置可缺省同上 string -
headers 提交请求头,设置可缺省同上 object -
where 提交参数的数据,设置可缺省同上 object -
autoParam 自动参数,可以根据配置项以及当前节点的数据传参,如: ['type', 'age=age', 'parentId=id'] ,那么其请求参数将包含: {type: '父节点 type', age: '父节点 age', parentId: '父节点 id'} array -

format 示例

treeTable.render({
  elem: '',
  tree: {
    enable: true,
    async: {
      format: function(trData, options, callback){
        // trData 为行数据、options 为 treeTable 属性选项
        // callbacck 为子节点的渲染函数
        // 可利用该函数对子节点数据进行异步请求或其他格式化处理
        var nodeList = [
          {id: 111, name: '子节点1'},
          {id: 333, name: '子节点3'}
        ];
        callback(nodeList);
      }
    }
  }
})
tree.callback

事件回调相关的属性集合,包含以下成员:

属性 描述
beforeExpand 展开前回调函数。可以在展开或者关闭之前调用,传入当前表格 id ,当前操作的行数据以及要展开或关闭的状态,若回调返回 false 则取消该次操作。 返回的参数包含: function(tableId, trData, expandFlag){ console.log(arguments); }
onExpand 展开或关闭后的回调函数,返回参数同 beforeExpand