最直接的方式是在树形数据中为节点显式设置 checked: true,Layui 会自动识别并渲染勾选状态;但仅对叶子节点可靠,父节点设 checked 会连带勾选所有子节点,且需确保每个节点有唯一 id 字段。
tree.render 时通过 data 的 checked 属性设默认选中
最直接的方式是在传入的树形数据中,为需要默认选中的节点显式设置 checked: true。layui 会自动识别并渲染为勾选状态,且不影响父子联动逻辑。
注意:该方式仅对「叶子节点」或「无 children 的节点」可靠;若父节点设置了 checked: true,其所有子节点也会被连带勾选(这是 Layui 默认行为,不是 bug)。
- 必须确保每个节点都有唯一
id字段,否则联动和后续 API 调用会失效 -
checked只接受布尔值true/false,不能用字符串"true" - 如果数据是后端返回的 JSON,需确认后端字段名与前端一致(常见坑:后端返回
is_checked或selected,但 Layui 只认checked)
使用 tree.setChecked() 在渲染后动态设置
当默认选中逻辑较复杂(比如只勾选叶子节点、或根据权限 ID 列表匹配),推荐在 tree.render() 完成后再调用 tree.setChecked()。这能绕过父节点自动展开/勾选子节点的问题。
示例:只勾选 ID 为 101 和 102 的节点,不管它们是否为父节点:
tree.render({
elem: '#treeDemo',
id: 'treeDemo', // 必须!否则 setChecked 报错
data: treeData,
showCheckbox: true
});
// 渲染完成后设置
tree.setChecked('treeDemo', [101, 102]);
-
id参数必须与tree.render()中的id严格一致,否则tree.setChecked()会抛出"Cannot read properties of undefined (reading 'getChecked')" - 传入空数组
[]可清空所有勾选,适合重置场景 - 该方法不触发
oncheck回调,如需手动通知业务逻辑,得额外调用
后端返回 checked 字段但前端不生效?检查 LAY_CHECKED
某些旧版 Layui 或自定义封装(如 treetable)会忽略原始 checked 字段,转而依赖 LAY_CHECKED 这个内部标记。此时即使数据里写了 checked: true,复选框也不会默认勾上。
解决办法是在数据加载后、tree.render() 前,手动补全该字段:
const processedData = treeData.map(node => ({
...node,
LAY_CHECKED: node.checked ? 'true' : 'false'
}));
-
LAY_CHECKED是字符串,值必须是'true'或'false',不是布尔值 - 这个字段仅在部分定制版本或 treetable 场景下需要,标准
tree模块通常不需要 - 如果用了
treetable,还要确认是否配置了checkName: 'checked',否则它可能读的是别的字段名
为什么父节点设 checked: true 后子节点全被勾选?
这是 Layui 树形组件的默认父子联动机制,不是 bug。设计初衷是保持树结构语义一致性:父节点代表“包含全部子项”的集合概念。
如果你明确需要「父节点可独立勾选,不控制子节点」,Layui 原生不支持,必须自行禁用联动:
- 不要在数据中设父节点的
checked,改用tree.setChecked()单独操作目标节点 - 监听
oncheck回调,当检测到父节点被勾选时,立即调用tree.setChecked()把子节点还原(慎用,易造成 UI 闪烁) - 万级节点下频繁调用
setCheckbox会卡顿,此时应优先考虑用虚拟滚动或分页加载替代整树渲染
真正难处理的从来不是怎么设默认选中,而是设完之后要不要联动、谁联动谁、联动时性能扛不扛得住——这些得结合你的数据规模和交互预期来权衡。











