zTree 是功能強大的 jQuery 樹形控件,支援異步加載、拖拽、複選/單選、編輯、大數據懶加載等。本文結合實戰總結最常用的配置項與代碼模式。
適合數據量大、需按需加載子節點的場景。
var setting = {
async: {
enable: true,
url: 'abc.ashx', // 請求地址
autoParam: ['id=parentId'], // 將父節點屬性作為參數傳遞
otherParam: { 'request': 'requestname' }, // 靜態參數
dataFilter: function(treeId, parentNode, responseData) {
// 可在此轉換後端返回格式為 zTree 標準格式
return responseData;
}
}
};
$.fn.zTree.init($("#tree"), setting);
關鍵點:后端需返回符合 zTree 節點格式的 JSON 陣列(含 id, pId, name, isParent 等)。
simpleData)后端返回扁平數據,前端自動構建樹結構:
var setting = {
data: {
simpleData: {
enable: true,
idKey: "id", // 節點唯一標識
pIdKey: "pId", // 父節點標識
rootPId: 0 // 根節點父 ID
}
}
};
// 后端數據示例:
// [{id:1, pId:0, name:"根節點"}, {id:2, pId:1, name:"子節點1"}, ...]
后端遞歸構建巢狀結構:
var setting = {
data: {
key: {
children: "children", // 子節點屬性名
name: "name", // 顯示文字屬性
checked: "checked" // 勾選狀態屬性
}
}
};
// 后端數據:
// [{name:"根", children:[{name:"子1"}, {name:"子2"}]}]
var setting = {
check: {
enable: true,
chkStyle: "checkbox", // "radio" 為單選
radioType: "all", // radio 分組範圍: "all" / "level"
chkboxType: { "Y": "ps", "N": "ps" } // 勾選聯動關係: Y=勾選時影響父(p)子(s), N=取消時影響
},
data: {
key: { checked: "checked" } // 映射后端字段
}
};
chkboxType 詳解:"Y": "ps" 表示勾選時向上關聯父節點、向下關聯子節點;"N": "ps" 取消勾選時同理。常用值:"Y":"s", "N":"s"(僅影響子節點)、"Y":"", "N":""(無聯動)。
隱藏內置編輯按鈕,改用自定義 HTML:
var setting = {
view: {
addHoverDom: addHoverDom,
removeHoverDom: removeHoverDom
},
edit: {
enable: true,
showRemoveBtn: false, // 隱藏默認刪除按鈕
showRenameBtn: false // 隱藏默認重命名按鈕
}
};
function addHoverDom(treeId, treeNode) {
var $span = $("#" + treeNode.tId + "_span");
if ($("#customBtn_" + treeNode.id).length) return;
var btnGroup = "<div class='custom-btns'>"
+ "<a id='addBtn_" + treeNode.id + "' title='添加子節點' href='javascript:;'>+</a>"
+ "<a id='editBtn_" + treeNode.id + "' title='編輯' href='javascript:;'>✎</a>"
+ "<a id='delBtn_" + treeNode.id + "' title='刪除' href='javascript:;'>×</a>"
+ "</div>";
$span.after(btnGroup);
// 綁定事件 (使用事件委派或直接綁定)
$("#addBtn_" + treeNode.id).on("click", function() { addNode(treeNode); });
$("#editBtn_" + treeNode.id).on("click", function() { editNode(treeNode); });
$("#delBtn_" + treeNode.id).on("click", function() { removeNode(treeNode); });
}
function removeHoverDom(treeId, treeNode) {
$("#addBtn_" + treeNode.id + ", #editBtn_" + treeNode.id + ", #delBtn_" + treeNode.id).remove();
$("#" + treeNode.tId + "_span .custom-btns").remove();
}
// 業務邏輯示例
function addNode(parentNode) {
var zTree = $.fn.zTree.getZTreeObj("tree");
var newNode = { name: "新節點", pId: parentNode.id };
zTree.addNodes(parentNode, newNode);
}
function editNode(node) {
var zTree = $.fn.zTree.getZTreeObj("tree");
zTree.editName(node); // 觸發內置重命名
}
function removeNode(node) {
if (confirm("確定刪除?")) {
var zTree = $.fn.zTree.getZTreeObj("tree");
zTree.removeNode(node);
}
}
var zTree = $.fn.zTree.getZTreeObj("tree"); // 獲取實例
// 節點操作
zTree.addNodes(parentNode, newNodes); // 添加
zTree.removeNode(node); // 刪除
zTree.updateNode(node); // 更新顯示
zTree.expandNode(node, true/false); // 展開/折疊
zTree.selectNode(node); // 選中
zTree.checkNode(node, true/false, true); // 勾選/取消 (true=觸發聯動)
// 獲取數據
var nodes = zTree.getNodes(); // 所有根節點
var checkedNodes = zTree.getCheckedNodes(true); // 獲取勾選節點
var selectedNodes = zTree.getSelectedNodes(); // 獲取選中節點
// 搜索/高亮
zTree.getNodesByParam("name", "關鍵詞", null); // 精確匹配
// 模糊搜索需自行遍歷
var setting = {
callback: {
beforeClick: function(treeId, treeNode) { return true; }, // 返回 false 阻止選中
onClick: function(event, treeId, treeNode) { console.log('點擊:', treeNode.name); },
beforeCheck: function(treeId, treeNode) { return true; }, // 返回 false 阻止勾選
onCheck: function(event, treeId, treeNode) { console.log('勾選變化:', treeNode.checked); },
beforeDrag: function(treeId, treeNodes) { return true; }, // 拖拽前
onDrop: function(event, treeId, treeNodes, targetNode, moveType) { /* 拖拽完成 */ },
onAsyncSuccess: function(event, treeId, treeNode, msg) { /* 異步加載成功 */ },
onAsyncError: function(event, treeId, treeNode, XMLHttpRequest, textStatus, errorThrown) { /* 異步失敗 */ }
}
};
async.enable 分頁/懶加載。onAsyncSuccess 中隱藏。addHoverDom 而非修改 zTree 源碼,便於升級維護。$.fn.zTree.destroy("tree") 釋放記憶體。