# 属性

# 基础属性

参数 说明 类型 可选值 默认值
el dom选择器 string — —
data 静态数据 array — —
emptText 当数据为空时显示的内容 string — 暂无数据
highlightCurrent 是否高亮当前选中节点 boolean — false
highlightNode 初始高亮选中的key string — —
defaultExpandAll 是否默认展开所有节点 boolean — false
autoExpandParent 展开子节点的时候是否自动展开父节点 boolean — false
expandOnClickNode 是否在点击文本的时候展开或者收缩节点,如果为 false,则只有点箭头图标的时候才会展开或者收缩节点 boolean — true
checkOnClickNode 复选框是否在点击文本的时候选中节点 boolean — false
radioOnClickNode 单选框是否在点击文本的时候选中节点 boolean — false
defaultExpandedKeys 默认展开的节点的 key 的数组 array — —
showCheckbox 是否显示checkbox boolean — false
checkStrictly 在显示复选框的情况下,是否严格的遵循父子不互相关联的做法 boolean — false
isDefaultChangePstatus 在显示复选框并且父子关联的情况下,初始数据是否只是子节点影响父节点,默认false,即父子关联 boolean — false
defaultCheckedKeys 默认勾选的节点的 key 的数组 array — —
accordion 是否每次只打开一个同级树节点展开(手风琴效果) boolean — false
indent 相邻级节点间的水平缩进,单位为像素 number — 16
showLine 是否显示虚线 boolean — true
imgUrl 图片所在的文件夹路径 string — ./images/
icon 使用自定义图标或图片(全局) object fold,leaf,checkFull,checkHalf,checkNone,dropdownOff,dropdownOn,loading,radioCheck,radioCheckNone 每个属性默认值均为空字符串
iconItem 自定义图标(单独设置某一个节点) function null
done 树渲染完成之后的回调,参数当异步时为后台返回数据,静态数据为{data: ...} function — —
lazy 开启懒加载 boolean — false
rightMenuList 开启右键菜单 array/function "copy", "paste", "paste_before", "paste_after", "cut_paste", "edit", "remove", "add_child", "add_before", "add_after" []
showRadio 是否显示radio boolean — false
radioType 单选范围(是同一级还是整体只能选择一个) string level/all level
defaultRadioCheckedKeys radio默认选中项 array — —
isOnlyShowLeafRadio 当显示radio的时候是否只显示叶子节点 boolean — false
defaultPid 当使用pid格式的数据时,第一层数据的默认值 string/number — ''
draggable 是否开启拖拽节点功能 boolean — false
customText 节点文本自定义函数;查看更多 function — —
sort 是否开启排序;查看更多 boolean — false
initSort 节点排序传入的控制参数 object id:对某一个节点排序, 不传则对最外层节点;field:按某个字段排序;type:升序asc降序desc;depth:深度,不传则为所有子节点 —

# 异步属性

参数 说明 类型 可选值 默认值
url 异步接口地址 string — —
method 接口http请求类型 string get,post get
where 接口的其它参数 object — —
headers 接口的请求头 object — —
response dom选择器 string — —
request dom选择器 string — —

# 默认配置

{
    el: "",                   // dom选择器
    data: [],                   // 静态数据
    emptText: "暂无数据",        // 内容为空的时候展示的文本
    highlightCurrent: false,    // 是否高亮当前选中节点,默认值是 false。  
    highlightNode: "",          // 初始高亮选中的key     
    defaultExpandAll: false,    // 是否默认展开所有节点                         
    expandOnClickNode: true,    // 是否在点击文本的时候展开或者收缩节点, 默认值为 true,如果为 false,则只有点箭头图标的时候才会展开或者收缩节点。
    checkOnClickNode: false,    // 复选框是否在点击文本的时候选中节点,默认值为 false,即只有在点击复选框时才会选中节点。
    radioOnClickNode: false,    // 单选框是否在点击文本的时候选中节点,默认值为 false,即只有在点击单选框时才会选中节点。
    defaultExpandedKeys: [],    // 默认展开的节点的 key 的数组 
    autoExpandParent: false,     // 展开子节点的时候是否自动展开父节点 
    showCheckbox: false,        // 节点是否可被选择 
    checkStrictly: false,       // 在显示复选框的情况下,是否严格的遵循父子不互相关联的做法,默认为 false  
    isDefaultChangePstatus: false,      // 在父子关联的情况下,初始数据是否只是子节点影响父节点,即父节点选中,子节点全部没有选中或部分选中,则让父节点也没有选中或者半选,默认false,即父子结点互相影响
    defaultCheckedKeys: [],     // 默认勾选的节点的 key 的数组  
    accordion: false,           // 是否每次只打开一个同级树节点展开(手风琴效果)  
    indent: 16,                 // 相邻级节点间的水平缩进,单位为像素           
    lazy: false,                // 当不是懒加载时,叶子节点由当前节点是否由子节点判断,如果为懒加载,则叶子节点由当前节点的属性isLeaf: true决定
    load: function() {},        // 加载子树数据的方法,仅当 lazy 属性为true 时生效
    draggable: false,           // 是否开启拖拽节点功能
    searchNodeMethod: null,     // 对树节点进行筛选时执行的方法,返回 true 表示这个节点可以显示,返回 false 则表示这个节点会被隐藏
    showLine: true,             // 是否显示连线,默认true
    imgUrl: "./images/",        // 图片所在的文件夹路径   
    icon: {                     // 自定义图标(全局)
        fold: "",
        leaf: "",
        checkFull: "",
        checkHalf: "",
        checkNone: "",
        dropdownOff: "",
        dropdownOn: "",
        loading: "",
        radioCheck: "",
        radioCheckNone: "",
    },
    iconItem: null,             // 自定义图标(单独设置某一个节点)
    rightMenuList: [],          // 右键菜单("copy", "paste", "paste_before", "paste_after", "cut_paste", "edit", "remove", "add_child", "add_before", "add_after")
    done: null,         // 树渲染完成之后的回调
    showRadio: false,               // 是否显示radio
    radioType: "level", // all      // 单选范围(是同一级还是整体只能选择一个)
    isOnlyShowLeafRadio: false,     // 是否只显示叶子节点的radio
    defaultRadioCheckedKeys: [],    // radio默认选中项
    customText: null,               // 节点文本自定义函数

    method: "get",      // 接口http请求类型
    url: "",            // 异步接口地址
    where: {},          // 接口的其它参数
    headers: {},        // 接口的请求头
    response: {         // 对后台返回的数据格式重新定义
        statusName: "code",
        statusCode: 0,
        dataName: "data"
    },
    defaultPid: "",     // 第一层pid的初始值
    request: {          // 对于后台数据重新定义名字
        name: "label",
        key: "id",
        children: "children",
        disabled: "disabled",       // 被禁用的节点不会影响父子节点的选中状态
        checked: "checked",
        isOpen: "isOpen",
        isLeaf: "isLeaf",
        pid: "pid",
        radioChecked: "radioChecked",
        radioDisabled: "radioDisabled"
    },
    sort: false,            // 是否开启排序,开启则使用initSort参数(对于懒加载,如果开启排序,并且不传深度,则执行排序,如果传深度,需要手动执行sort方法)
    initSort: {
        id: null,           // 对某一个节点排序, 不传则对最外层节点
        field: "label",     // 按某个字段排序
        type: "asc",        // asc:升序, desc:降序 
        depth: null,        // 深度,不传则为最深层,支持数字,1/2/3
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
Last Updated: 4/16/2026, 6:27:00 AM