tree.getChecked() 不存在于 Layui 官方 API,正确方式是调用 tree.getData() 获取深拷贝数据后手动递归过滤 checked 节点。
tree.getChecked() 为什么总是返回空数组
因为 tree.getchecked() 不是 layui 官方 api —— 这个方法在 layui 2.8.x 及所有公开文档中根本不存在。你看到的示例,大概率是别人自己封装的函数,或是把 form.val()、table.checkstatus() 等其他组件的方法记混了。
直接在控制台执行 tree.getChecked(),几乎必然报错 Cannot read property 'getChecked' of undefined 或返回 undefined。根源在于:Layui 原生 tree 模块不提供该方法,也不维护“已勾选节点缓存”。
- 别再搜 “layui tree getChecked” —— 这是个无效关键词,只会把你引向魔改版或错误教程
- 如果你用的是某 CMS 内置的“增强版 Layui”,得翻它加载的额外 JS 文件,确认是否手动挂载了该方法
- 稳妥且兼容所有官方版本的做法,只有两个字:遍历
正确获取选中节点 ID 和数据的唯一路径
必须结合 tree.getData() + 手动递归过滤。注意:getData() 返回的是当前树渲染状态的**深拷贝数据**,它已同步了用户勾选动作(前提是初始化时设了 showCheckbox: true),但不会包含 DOM 引用或 layui 内部标记字段。
示例代码(放在 oncheck 或点击按钮回调里):
tree.on('check(test)', function(obj) {
const allData = treeObj.getData(); // treeObj 是 render() 返回的实例
const getCheckedNodes = (nodes) => {
let result = [];
nodes.forEach(node => {
if (node.checked) result.push(node);
if (Array.isArray(node.children)) {
result = result.concat(getCheckedNodes(node.children));
}
});
return result;
};
const checkedNodes = getCheckedNodes(allData);
console.log(checkedNodes); // [{id: 5, title: "编辑", checked: true}, ...]
});
-
getData()必须在树渲染完成后调用,不能读初始化传入的原始data数组(它不会自动更新勾选状态) - 如果树用了
isLazy: true,未展开过的子节点不会出现在getData()返回的数据里,自然也不会被遍历到 - 节点
id字段必须存在且唯一;重复id会导致遍历结果不可靠
为什么 setChecked 后 getData() 仍没反应
调用 tree.setChecked('id', [1,2]) 仅触发 UI 勾选,但不会自动修改底层数据的 checked 字段 —— 这是 Layui 的设计逻辑:UI 状态和数据状态默认不同步。
想让 getData() 返回带正确 checked 值的数据,必须满足以下任一条件:
- 初始化树时,每个节点显式声明
checked: true/false(适用于静态data方式) - 使用异步
url加载时,后端返回的 JSON 中每个节点含布尔型checked字段(不是字符串"true") - 手动同步:调用
setChecked后,再用tree.update()更新对应节点的checked字段(需先用getData()找到目标节点)
否则,getData() 返回的数据里,checked 仍是初始值,遍历结果就和 UI 显示不一致。
级联勾选(cascade: true)下怎么拿到全部生效节点
开启级联后,父节点勾选会视觉上连带子节点,但 getData() 返回的数据里,子节点的 checked 字段**确实会被设为 true** —— 这点和很多人直觉相反。所以你照常递归遍历就能拿到所有实际生效的节点,无需额外展开或模拟级联逻辑。
但要注意一个边界:如果父节点被勾选,而其子节点因 isLazy: true 尚未加载,那些子节点根本不在 getData() 结果中,自然也不会出现在遍历结果里。此时你拿到的只是“当前已知范围内”的勾选节点。
真正容易被忽略的点是:Layui 树组件从不保证数据结构的完整性。它只渲染当前可见/已加载的部分,getData() 也只返回这部分。所谓“全部选中节点”,永远受限于你实际加载了多少数据。


















