• Tree 树形控件
    • 基础用法
    • 可选择
    • 懒加载自定义叶子节点
    • 默认展开和默认选中
    • 禁用状态
    • 树节点的选择
    • 自定义节点内容
    • 节点过滤
    • 手风琴模式
    • 可拖拽节点
    • Attributes
    • props
    • 方法
    • Events
    • Scoped Slot

    Tree 树形控件

    用清晰的层级结构展示信息,可展开或折叠。

    基础用法

    基础的树形结构展示。

    Tree 树形控件 - 图1

    1. <el-tree :data="data" :props="defaultProps" @node-click="handleNodeClick"></el-tree>
    2. <script>
    3. export default {
    4. data() {
    5. return {
    6. data: [{
    7. label: '一级 1',
    8. children: [{
    9. label: '二级 1-1',
    10. children: [{
    11. label: '三级 1-1-1'
    12. }]
    13. }]
    14. }, {
    15. label: '一级 2',
    16. children: [{
    17. label: '二级 2-1',
    18. children: [{
    19. label: '三级 2-1-1'
    20. }]
    21. }, {
    22. label: '二级 2-2',
    23. children: [{
    24. label: '三级 2-2-1'
    25. }]
    26. }]
    27. }, {
    28. label: '一级 3',
    29. children: [{
    30. label: '二级 3-1',
    31. children: [{
    32. label: '三级 3-1-1'
    33. }]
    34. }, {
    35. label: '二级 3-2',
    36. children: [{
    37. label: '三级 3-2-1'
    38. }]
    39. }]
    40. }],
    41. defaultProps: {
    42. children: 'children',
    43. label: 'label'
    44. }
    45. };
    46. },
    47. methods: {
    48. handleNodeClick(data) {
    49. console.log(data);
    50. }
    51. }
    52. };
    53. </script>

    可选择

    适用于需要选择层级时使用。

    Tree 树形控件 - 图2

    本例还展示了动态加载节点数据的方法。

    1. <el-tree
    2. :props="props"
    3. :load="loadNode"
    4. lazy
    5. show-checkbox
    6. @check-change="handleCheckChange">
    7. </el-tree>
    8. <script>
    9. export default {
    10. data() {
    11. return {
    12. props: {
    13. label: 'name',
    14. children: 'zones'
    15. },
    16. count: 1
    17. };
    18. },
    19. methods: {
    20. handleCheckChange(data, checked, indeterminate) {
    21. console.log(data, checked, indeterminate);
    22. },
    23. handleNodeClick(data) {
    24. console.log(data);
    25. },
    26. loadNode(node, resolve) {
    27. if (node.level === 0) {
    28. return resolve([{ name: 'region1' }, { name: 'region2' }]);
    29. }
    30. if (node.level > 3) return resolve([]);
    31. var hasChild;
    32. if (node.data.name === 'region1') {
    33. hasChild = true;
    34. } else if (node.data.name === 'region2') {
    35. hasChild = false;
    36. } else {
    37. hasChild = Math.random() > 0.5;
    38. }
    39. setTimeout(() => {
    40. var data;
    41. if (hasChild) {
    42. data = [{
    43. name: 'zone' + this.count++
    44. }, {
    45. name: 'zone' + this.count++
    46. }];
    47. } else {
    48. data = [];
    49. }
    50. resolve(data);
    51. }, 500);
    52. }
    53. }
    54. };
    55. </script>

    懒加载自定义叶子节点

    Tree 树形控件 - 图3

    由于在点击节点时才进行该层数据的获取,默认情况下 Tree 无法预知某个节点是否为叶子节点,所以会为每个节点添加一个下拉按钮,如果节点没有下层数据,则点击后下拉按钮会消失。同时,你也可以提前告知 Tree 某个节点是否为叶子节点,从而避免在叶子节点前渲染下拉按钮。

    1. <el-tree
    2. :props="props"
    3. :load="loadNode1"
    4. lazy
    5. show-checkbox>
    6. </el-tree>
    7. <script>
    8. export default {
    9. data() {
    10. return {
    11. props: {
    12. label: 'name',
    13. children: 'zones',
    14. isLeaf: 'leaf'
    15. },
    16. };
    17. },
    18. methods: {
    19. loadNode1(node, resolve) {
    20. if (node.level === 0) {
    21. return resolve([{ name: 'region' }]);
    22. }
    23. if (node.level > 1) return resolve([]);
    24. setTimeout(() => {
    25. const data = [{
    26. name: 'leaf',
    27. leaf: true
    28. }, {
    29. name: 'zone'
    30. }];
    31. resolve(data);
    32. }, 500);
    33. }
    34. }
    35. };
    36. </script>

    默认展开和默认选中

    可将 Tree 的某些节点设置为默认展开或默认选中

    Tree 树形控件 - 图4

    分别通过default-expanded-keysdefault-checked-keys设置默认展开和默认选中的节点。需要注意的是,此时必须设置node-key,其值为节点数据中的一个字段名,该字段在整棵树中是唯一的。

    1. <el-tree
    2. :data="data"
    3. show-checkbox
    4. node-key="id"
    5. :default-expanded-keys="[2, 3]"
    6. :default-checked-keys="[5]"
    7. :props="defaultProps">
    8. </el-tree>
    9. <script>
    10. export default {
    11. data() {
    12. return {
    13. data: [{
    14. id: 1,
    15. label: '一级 1',
    16. children: [{
    17. id: 4,
    18. label: '二级 1-1',
    19. children: [{
    20. id: 9,
    21. label: '三级 1-1-1'
    22. }, {
    23. id: 10,
    24. label: '三级 1-1-2'
    25. }]
    26. }]
    27. }, {
    28. id: 2,
    29. label: '一级 2',
    30. children: [{
    31. id: 5,
    32. label: '二级 2-1'
    33. }, {
    34. id: 6,
    35. label: '二级 2-2'
    36. }]
    37. }, {
    38. id: 3,
    39. label: '一级 3',
    40. children: [{
    41. id: 7,
    42. label: '二级 3-1'
    43. }, {
    44. id: 8,
    45. label: '二级 3-2'
    46. }]
    47. }],
    48. defaultProps: {
    49. children: 'children',
    50. label: 'label'
    51. }
    52. };
    53. }
    54. };
    55. </script>

    禁用状态

    可将 Tree 的某些节点设置为禁用状态

    Tree 树形控件 - 图5

    通过disabled设置禁用状态。

    1. <el-tree
    2. :data="data"
    3. show-checkbox
    4. node-key="id"
    5. :default-expanded-keys="[2, 3]"
    6. :default-checked-keys="[5]">
    7. </el-tree>
    8. <script>
    9. export default {
    10. data() {
    11. return {
    12. data: [{
    13. id: 1,
    14. label: '一级 2',
    15. children: [{
    16. id: 3,
    17. label: '二级 2-1',
    18. children: [{
    19. id: 4,
    20. label: '三级 3-1-1'
    21. }, {
    22. id: 5,
    23. label: '三级 3-1-2',
    24. disabled: true
    25. }]
    26. }, {
    27. id: 2,
    28. label: '二级 2-2',
    29. disabled: true,
    30. children: [{
    31. id: 6,
    32. label: '三级 3-2-1'
    33. }, {
    34. id: 7,
    35. label: '三级 3-2-2',
    36. disabled: true
    37. }]
    38. }]
    39. }],
    40. defaultProps: {
    41. children: 'children',
    42. label: 'label'
    43. }
    44. };
    45. }
    46. };
    47. </script>

    树节点的选择

    Tree 树形控件 - 图6

    本例展示如何获取和设置选中节点。获取和设置各有两种方式:通过 node 或通过 key。如果需要通过 key 来获取或设置,则必须设置node-key

    1. <el-tree
    2. :data="data"
    3. show-checkbox
    4. default-expand-all
    5. node-key="id"
    6. ref="tree"
    7. highlight-current
    8. :props="defaultProps">
    9. </el-tree>
    10. <div class="buttons">
    11. <el-button @click="getCheckedNodes">通过 node 获取</el-button>
    12. <el-button @click="getCheckedKeys">通过 key 获取</el-button>
    13. <el-button @click="setCheckedNodes">通过 node 设置</el-button>
    14. <el-button @click="setCheckedKeys">通过 key 设置</el-button>
    15. <el-button @click="resetChecked">清空</el-button>
    16. </div>
    17. <script>
    18. export default {
    19. methods: {
    20. getCheckedNodes() {
    21. console.log(this.$refs.tree.getCheckedNodes());
    22. },
    23. getCheckedKeys() {
    24. console.log(this.$refs.tree.getCheckedKeys());
    25. },
    26. setCheckedNodes() {
    27. this.$refs.tree.setCheckedNodes([{
    28. id: 5,
    29. label: '二级 2-1'
    30. }, {
    31. id: 9,
    32. label: '三级 1-1-1'
    33. }]);
    34. },
    35. setCheckedKeys() {
    36. this.$refs.tree.setCheckedKeys([3]);
    37. },
    38. resetChecked() {
    39. this.$refs.tree.setCheckedKeys([]);
    40. }
    41. },
    42. data() {
    43. return {
    44. data: [{
    45. id: 1,
    46. label: '一级 1',
    47. children: [{
    48. id: 4,
    49. label: '二级 1-1',
    50. children: [{
    51. id: 9,
    52. label: '三级 1-1-1'
    53. }, {
    54. id: 10,
    55. label: '三级 1-1-2'
    56. }]
    57. }]
    58. }, {
    59. id: 2,
    60. label: '一级 2',
    61. children: [{
    62. id: 5,
    63. label: '二级 2-1'
    64. }, {
    65. id: 6,
    66. label: '二级 2-2'
    67. }]
    68. }, {
    69. id: 3,
    70. label: '一级 3',
    71. children: [{
    72. id: 7,
    73. label: '二级 3-1'
    74. }, {
    75. id: 8,
    76. label: '二级 3-2'
    77. }]
    78. }],
    79. defaultProps: {
    80. children: 'children',
    81. label: 'label'
    82. }
    83. };
    84. }
    85. };
    86. </script>

    自定义节点内容

    节点的内容支持自定义,可以在节点区添加按钮或图标等内容

    Tree 树形控件 - 图7

    可以通过两种方法进行树节点内容的自定义:render-content和 scoped slot。使用render-content指定渲染函数,该函数返回需要的节点区内容即可。渲染函数的用法请参考 Vue 文档。使用 scoped slot 会传入两个参数nodedata,分别表示当前节点的 Node 对象和当前节点的数据。注意:由于 jsfiddle 不支持 JSX 语法,所以render-content示例在 jsfiddle 中无法运行。但是在实际的项目中,只要正确地配置了相关依赖,就可以正常运行。

    1. <div class="custom-tree-container">
    2. <div class="block">
    3. <p>使用 render-content</p>
    4. <el-tree
    5. :data="data"
    6. show-checkbox
    7. node-key="id"
    8. default-expand-all
    9. :expand-on-click-node="false"
    10. :render-content="renderContent">
    11. </el-tree>
    12. </div>
    13. <div class="block">
    14. <p>使用 scoped slot</p>
    15. <el-tree
    16. :data="data"
    17. show-checkbox
    18. node-key="id"
    19. default-expand-all
    20. :expand-on-click-node="false">
    21. <span class="custom-tree-node" slot-scope="{ node, data }">
    22. <span>{{ node.label }}</span>
    23. <span>
    24. <el-button
    25. type="text"
    26. size="mini"
    27. @click="() => append(data)">
    28. Append
    29. </el-button>
    30. <el-button
    31. type="text"
    32. size="mini"
    33. @click="() => remove(node, data)">
    34. Delete
    35. </el-button>
    36. </span>
    37. </span>
    38. </el-tree>
    39. </div>
    40. </div>
    41. <script>
    42. let id = 1000;
    43. export default {
    44. data() {
    45. const data = [{
    46. id: 1,
    47. label: '一级 1',
    48. children: [{
    49. id: 4,
    50. label: '二级 1-1',
    51. children: [{
    52. id: 9,
    53. label: '三级 1-1-1'
    54. }, {
    55. id: 10,
    56. label: '三级 1-1-2'
    57. }]
    58. }]
    59. }, {
    60. id: 2,
    61. label: '一级 2',
    62. children: [{
    63. id: 5,
    64. label: '二级 2-1'
    65. }, {
    66. id: 6,
    67. label: '二级 2-2'
    68. }]
    69. }, {
    70. id: 3,
    71. label: '一级 3',
    72. children: [{
    73. id: 7,
    74. label: '二级 3-1'
    75. }, {
    76. id: 8,
    77. label: '二级 3-2'
    78. }]
    79. }];
    80. return {
    81. data: JSON.parse(JSON.stringify(data)),
    82. data: JSON.parse(JSON.stringify(data))
    83. }
    84. },
    85. methods: {
    86. append(data) {
    87. const newChild = { id: id++, label: 'testtest', children: [] };
    88. if (!data.children) {
    89. this.$set(data, 'children', []);
    90. }
    91. data.children.push(newChild);
    92. },
    93. remove(node, data) {
    94. const parent = node.parent;
    95. const children = parent.data.children || parent.data;
    96. const index = children.findIndex(d => d.id === data.id);
    97. children.splice(index, 1);
    98. },
    99. renderContent(h, { node, data, store }) {
    100. return (
    101. <span class="custom-tree-node">
    102. <span>{node.label}</span>
    103. <span>
    104. <el-button size="mini" type="text" on-click={ () => this.append(data) }>Append</el-button>
    105. <el-button size="mini" type="text" on-click={ () => this.remove(node, data) }>Delete</el-button>
    106. </span>
    107. </span>);
    108. }
    109. }
    110. };
    111. </script>
    112. <style>
    113. .custom-tree-node {
    114. flex: 1;
    115. display: flex;
    116. align-items: center;
    117. justify-content: space-between;
    118. font-size: 14px;
    119. padding-right: 8px;
    120. }
    121. </style>

    节点过滤

    通过关键字过滤树节点

    Tree 树形控件 - 图8

    在需要对节点进行过滤时,调用 Tree 实例的filter方法,参数为关键字。需要注意的是,此时需要设置filter-node-method,值为过滤函数。

    1. <el-input
    2. placeholder="输入关键字进行过滤"
    3. v-model="filterText">
    4. </el-input>
    5. <el-tree
    6. class="filter-tree"
    7. :data="data"
    8. :props="defaultProps"
    9. default-expand-all
    10. :filter-node-method="filterNode"
    11. ref="tree2">
    12. </el-tree>
    13. <script>
    14. export default {
    15. watch: {
    16. filterText(val) {
    17. this.$refs.tree2.filter(val);
    18. }
    19. },
    20. methods: {
    21. filterNode(value, data) {
    22. if (!value) return true;
    23. return data.label.indexOf(value) !== -1;
    24. }
    25. },
    26. data() {
    27. return {
    28. filterText: '',
    29. data: [{
    30. id: 1,
    31. label: '一级 1',
    32. children: [{
    33. id: 4,
    34. label: '二级 1-1',
    35. children: [{
    36. id: 9,
    37. label: '三级 1-1-1'
    38. }, {
    39. id: 10,
    40. label: '三级 1-1-2'
    41. }]
    42. }]
    43. }, {
    44. id: 2,
    45. label: '一级 2',
    46. children: [{
    47. id: 5,
    48. label: '二级 2-1'
    49. }, {
    50. id: 6,
    51. label: '二级 2-2'
    52. }]
    53. }, {
    54. id: 3,
    55. label: '一级 3',
    56. children: [{
    57. id: 7,
    58. label: '二级 3-1'
    59. }, {
    60. id: 8,
    61. label: '二级 3-2'
    62. }]
    63. }],
    64. defaultProps: {
    65. children: 'children',
    66. label: 'label'
    67. }
    68. };
    69. }
    70. };
    71. </script>

    手风琴模式

    对于同一级的节点,每次只能展开一个

    Tree 树形控件 - 图9

    1. <el-tree
    2. :data="data"
    3. :props="defaultProps"
    4. accordion
    5. @node-click="handleNodeClick">
    6. </el-tree>
    7. <script>
    8. export default {
    9. data() {
    10. return {
    11. data: [{
    12. label: '一级 1',
    13. children: [{
    14. label: '二级 1-1',
    15. children: [{
    16. label: '三级 1-1-1'
    17. }]
    18. }]
    19. }, {
    20. label: '一级 2',
    21. children: [{
    22. label: '二级 2-1',
    23. children: [{
    24. label: '三级 2-1-1'
    25. }]
    26. }, {
    27. label: '二级 2-2',
    28. children: [{
    29. label: '三级 2-2-1'
    30. }]
    31. }]
    32. }, {
    33. label: '一级 3',
    34. children: [{
    35. label: '二级 3-1',
    36. children: [{
    37. label: '三级 3-1-1'
    38. }]
    39. }, {
    40. label: '二级 3-2',
    41. children: [{
    42. label: '三级 3-2-1'
    43. }]
    44. }]
    45. }],
    46. defaultProps: {
    47. children: 'children',
    48. label: 'label'
    49. }
    50. };
    51. },
    52. methods: {
    53. handleNodeClick(data) {
    54. console.log(data);
    55. }
    56. }
    57. };
    58. </script>

    可拖拽节点

    通过 draggable 属性可让节点变为可拖拽。

    Tree 树形控件 - 图10

    1. <el-tree
    2. :data="data"
    3. node-key="id"
    4. default-expand-all
    5. @node-drag-start="handleDragStart"
    6. @node-drag-enter="handleDragEnter"
    7. @node-drag-leave="handleDragLeave"
    8. @node-drag-over="handleDragOver"
    9. @node-drag-end="handleDragEnd"
    10. @node-drop="handleDrop"
    11. draggable
    12. :allow-drop="allowDrop"
    13. :allow-drag="allowDrag">
    14. </el-tree>
    15. <script>
    16. export default {
    17. data() {
    18. return {
    19. data: [{
    20. id: 1,
    21. label: '一级 1',
    22. children: [{
    23. id: 4,
    24. label: '二级 1-1',
    25. children: [{
    26. id: 9,
    27. label: '三级 1-1-1'
    28. }, {
    29. id: 10,
    30. label: '三级 1-1-2'
    31. }]
    32. }]
    33. }, {
    34. id: 2,
    35. label: '一级 2',
    36. children: [{
    37. id: 5,
    38. label: '二级 2-1'
    39. }, {
    40. id: 6,
    41. label: '二级 2-2'
    42. }]
    43. }, {
    44. id: 3,
    45. label: '一级 3',
    46. children: [{
    47. id: 7,
    48. label: '二级 3-1'
    49. }, {
    50. id: 8,
    51. label: '二级 3-2',
    52. children: [{
    53. id: 11,
    54. label: '三级 3-2-1'
    55. }, {
    56. id: 12,
    57. label: '三级 3-2-2'
    58. }, {
    59. id: 13,
    60. label: '三级 3-2-3'
    61. }]
    62. }]
    63. }],
    64. defaultProps: {
    65. children: 'children',
    66. label: 'label'
    67. }
    68. };
    69. },
    70. methods: {
    71. handleDragStart(node, ev) {
    72. console.log('drag start', node);
    73. },
    74. handleDragEnter(draggingNode, dropNode, ev) {
    75. console.log('tree drag enter: ', dropNode.label);
    76. },
    77. handleDragLeave(draggingNode, dropNode, ev) {
    78. console.log('tree drag leave: ', dropNode.label);
    79. },
    80. handleDragOver(draggingNode, dropNode, ev) {
    81. console.log('tree drag over: ', dropNode.label);
    82. },
    83. handleDragEnd(draggingNode, dropNode, dropType, ev) {
    84. console.log('tree drag end: ', dropNode && dropNode.label, dropType);
    85. },
    86. handleDrop(draggingNode, dropNode, dropType, ev) {
    87. console.log('tree drop: ', dropNode.label, dropType);
    88. },
    89. allowDrop(draggingNode, dropNode, type) {
    90. if (dropNode.data.label === '二级 3-1') {
    91. return type !== 'inner';
    92. } else {
    93. return true;
    94. }
    95. },
    96. allowDrag(draggingNode) {
    97. return draggingNode.data.label.indexOf('三级 3-2-2') === -1;
    98. }
    99. }
    100. };
    101. </script>

    Attributes

    参数说明类型可选值默认值
    data展示数据array
    empty-text内容为空的时候展示的文本String
    node-key每个树节点用来作为唯一标识的属性,整棵树应该是唯一的String
    props配置选项,具体看下表object
    render-after-expand是否在第一次展开某个树节点后才渲染其子节点booleantrue
    load加载子树数据的方法,仅当 lazy 属性为true 时生效function(node, resolve)
    render-content树节点的内容区的渲染 FunctionFunction(h, { node, data, store }
    highlight-current是否高亮当前选中节点,默认值是 false。booleanfalse
    default-expand-all是否默认展开所有节点booleanfalse
    expand-on-click-node是否在点击节点的时候展开或者收缩节点, 默认值为 true,如果为 false,则只有点箭头图标的时候才会展开或者收缩节点。booleantrue
    check-on-click-node是否在点击节点的时候选中节点,默认值为 false,即只有在点击复选框时才会选中节点。booleanfalse
    auto-expand-parent展开子节点的时候是否自动展开父节点booleantrue
    default-expanded-keys默认展开的节点的 key 的数组array
    show-checkbox节点是否可被选择booleanfalse
    check-strictly在显示复选框的情况下,是否严格的遵循父子不互相关联的做法,默认为 falsebooleanfalse
    default-checked-keys默认勾选的节点的 key 的数组array
    current-node-key当前选中的节点string, number
    filter-node-method对树节点进行筛选时执行的方法,返回 true 表示这个节点可以显示,返回 false 则表示这个节点会被隐藏Function(value, data, node)
    accordion是否每次只打开一个同级树节点展开booleanfalse
    indent相邻级节点间的水平缩进,单位为像素number16
    icon-class自定义树节点的图标string--
    lazy是否懒加载子节点,需与 load 方法结合使用booleanfalse
    draggable是否开启拖拽节点功能booleanfalse
    allow-drag判断节点能否被拖拽Function(node)
    allow-drop拖拽时判定目标节点能否被放置。type 参数有三种情况:'prev'、'inner' 和 'next',分别表示放置在目标节点前、插入至目标节点和放置在目标节点后Function(draggingNode, dropNode, type)

    props

    参数说明类型可选值默认值
    label指定节点标签为节点对象的某个属性值string, function(data, node)
    children指定子树为节点对象的某个属性值string
    disabled指定节点选择框是否禁用为节点对象的某个属性值boolean, function(data, node)
    isLeaf指定节点是否为叶子节点,仅在指定了 lazy 属性的情况下生效boolean, function(data, node)

    方法

    Tree 内部使用了 Node 类型的对象来包装用户传入的数据,用来保存目前节点的状态。Tree 拥有如下方法:

    方法名说明参数
    filter对树节点进行筛选操作接收一个任意类型的参数,该参数会在 filter-node-method 中作为第一个参数
    updateKeyChildren通过 keys 设置节点子元素,使用此方法必须设置 node-key 属性(key, data) 接收两个参数,1. 节点 key 2. 节点数据的数组
    getCheckedNodes若节点可被选择(即 show-checkboxtrue),则返回目前被选中的节点所组成的数组(leafOnly, includeHalfChecked) 接收两个 boolean 类型的参数,1. 是否只是叶子节点,默认值为 false 2. 是否包含半选节点,默认值为 false
    setCheckedNodes设置目前勾选的节点,使用此方法必须设置 node-key 属性(nodes) 接收勾选节点数据的数组
    getCheckedKeys若节点可被选择(即 show-checkboxtrue),则返回目前被选中的节点的 key 所组成的数组(leafOnly) 接收一个 boolean 类型的参数,若为 true 则仅返回被选中的叶子节点的 keys,默认值为 false
    setCheckedKeys通过 keys 设置目前勾选的节点,使用此方法必须设置 node-key 属性(keys, leafOnly) 接收两个参数,1. 勾选节点的 key 的数组 2. boolean 类型的参数,若为 true 则仅设置叶子节点的选中状态,默认值为 false
    setChecked通过 key / data 设置某个节点的勾选状态,使用此方法必须设置 node-key 属性(key/data, checked, deep) 接收三个参数,1. 勾选节点的 key 或者 data 2. boolean 类型,节点是否选中 3. boolean 类型,是否设置子节点 ,默认为 false
    getHalfCheckedNodes若节点可被选择(即 show-checkboxtrue),则返回目前半选中的节点所组成的数组-
    getHalfCheckedKeys若节点可被选择(即 show-checkboxtrue),则返回目前半选中的节点的 key 所组成的数组-
    getCurrentKey获取当前被选中节点的 key,使用此方法必须设置 node-key 属性,若没有节点被选中则返回 null
    getCurrentNode获取当前被选中节点的 data,若没有节点被选中则返回 null
    setCurrentKey通过 key 设置某个节点的当前选中状态,使用此方法必须设置 node-key 属性(key) 待被选节点的 key,若为 null 则取消当前高亮的节点
    setCurrentNode通过 node 设置某个节点的当前选中状态,使用此方法必须设置 node-key 属性(node) 待被选节点的 node
    getNode根据 data 或者 key 拿到 Tree 组件中的 node(data) 要获得 node 的 key 或者 data
    remove删除 Tree 中的一个节点,使用此方法必须设置 node-key 属性(data) 要删除的节点的 data 或者 node
    append为 Tree 中的一个节点追加一个子节点(data, parentNode) 接收两个参数,1. 要追加的子节点的 data 2. 子节点的 parent 的 data、key 或者 node
    insertBefore为 Tree 的一个节点的前面增加一个节点(data, refNode) 接收两个参数,1. 要增加的节点的 data 2. 要增加的节点的后一个节点的 data、key 或者 node
    insertAfter为 Tree 的一个节点的后面增加一个节点(data, refNode) 接收两个参数,1. 要增加的节点的 data 2. 要增加的节点的前一个节点的 data、key 或者 node

    Events

    事件名称说明回调参数
    node-click节点被点击时的回调共三个参数,依次为:传递给 data 属性的数组中该节点所对应的对象、节点对应的 Node、节点组件本身。
    node-contextmenu当某一节点被鼠标右键点击时会触发该事件共四个参数,依次为:event、传递给 data 属性的数组中该节点所对应的对象、节点对应的 Node、节点组件本身。
    check-change节点选中状态发生变化时的回调共三个参数,依次为:传递给 data 属性的数组中该节点所对应的对象、节点本身是否被选中、节点的子树中是否有被选中的节点
    check当复选框被点击的时候触发共两个参数,依次为:传递给 data 属性的数组中该节点所对应的对象、树目前的选中状态对象,包含 checkedNodes、checkedKeys、halfCheckedNodes、halfCheckedKeys 四个属性
    current-change当前选中节点变化时触发的事件共两个参数,依次为:当前节点的数据,当前节点的 Node 对象
    node-expand节点被展开时触发的事件共三个参数,依次为:传递给 data 属性的数组中该节点所对应的对象、节点对应的 Node、节点组件本身
    node-collapse节点被关闭时触发的事件共三个参数,依次为:传递给 data 属性的数组中该节点所对应的对象、节点对应的 Node、节点组件本身
    node-drag-start节点开始拖拽时触发的事件共两个参数,依次为:被拖拽节点对应的 Node、event
    node-drag-enter拖拽进入其他节点时触发的事件共三个参数,依次为:被拖拽节点对应的 Node、所进入节点对应的 Node、event
    node-drag-leave拖拽离开某个节点时触发的事件共三个参数,依次为:被拖拽节点对应的 Node、所离开节点对应的 Node、event
    node-drag-over在拖拽节点时触发的事件(类似浏览器的 mouseover 事件)共三个参数,依次为:被拖拽节点对应的 Node、当前进入节点对应的 Node、event
    node-drag-end拖拽结束时(可能未成功)触发的事件共四个参数,依次为:被拖拽节点对应的 Node、结束拖拽时最后进入的节点(可能为空)、被拖拽节点的放置位置(before、after、inner)、event
    node-drop拖拽成功完成时触发的事件共四个参数,依次为:被拖拽节点对应的 Node、结束拖拽时最后进入的节点、被拖拽节点的放置位置(before、after、inner)、event

    Scoped Slot

    name说明
    自定义树节点的内容,参数为 { node, data }