ElementPlus Tree 樹形控件

Tree 樹形控件

用清晰的層級結(jié)構(gòu)展示信息，可展開或折疊。

基礎(chǔ)用法

基礎(chǔ)的樹形結(jié)構(gòu)展示。

<template>
  <el-tree
  :data="data"
  :props="defaultProps"
  @node-click="handleNodeClick"
></el-tree>
</template>

<script>
  export default {
    data() {
      return {
        data: [
          {
            label: '一級 1',
            children: [
              {
                label: '二級 1-1',
                children: [
                  {
                    label: '三級 1-1-1',
                  },
                ],
              },
            ],
          },
          {
            label: '一級 2',
            children: [
              {
                label: '二級 2-1',
                children: [
                  {
                    label: '三級 2-1-1',
                  },
                ],
              },
              {
                label: '二級 2-2',
                children: [
                  {
                    label: '三級 2-2-1',
                  },
                ],
              },
            ],
          },
          {
            label: '一級 3',
            children: [
              {
                label: '二級 3-1',
                children: [
                  {
                    label: '三級 3-1-1',
                  },
                ],
              },
              {
                label: '二級 3-2',
                children: [
                  {
                    label: '三級 3-2-1',
                  },
                ],
              },
            ],
          },
        ],
        defaultProps: {
          children: 'children',
          label: 'label',
        },
      }
    },
    methods: {
      handleNodeClick(data) {
        console.log(data)
      },
    },
  }
</script>

可選擇

適用于需要選擇層級時使用。

本例還展示了動態(tài)加載節(jié)點(diǎn)數(shù)據(jù)的方法。

<template>
  <el-tree
  :props="props"
  :load="loadNode"
  lazy
  show-checkbox
  @check-change="handleCheckChange"
>
</el-tree>
</template>

<script>
  export default {
    data() {
      return {
        props: {
          label: 'name',
          children: 'zones',
        },
        count: 1,
      }
    },
    methods: {
      handleCheckChange(data, checked, indeterminate) {
        console.log(data, checked, indeterminate)
      },
      handleNodeClick(data) {
        console.log(data)
      },
      loadNode(node, resolve) {
        if (node.level === 0) {
          return resolve([{ name: 'region1' }, { name: 'region2' }])
        }
        if (node.level > 3) return resolve([])

        var hasChild
        if (node.data.name === 'region1') {
          hasChild = true
        } else if (node.data.name === 'region2') {
          hasChild = false
        } else {
          hasChild = Math.random() > 0.5
        }

        setTimeout(() => {
          var data
          if (hasChild) {
            data = [
              {
                name: 'zone' + this.count++,
              },
              {
                name: 'zone' + this.count++,
              },
            ]
          } else {
            data = []
          }

          resolve(data)
        }, 500)
      },
    },
  }
</script>

懶加載自定義葉子節(jié)點(diǎn)

由于在點(diǎn)擊節(jié)點(diǎn)時才進(jìn)行該層數(shù)據(jù)的獲取，默認(rèn)情況下 Tree 無法預(yù)知某個節(jié)點(diǎn)是否為葉子節(jié)點(diǎn)，所以會為每個節(jié)點(diǎn)添加一個下拉按鈕，如果節(jié)點(diǎn)沒有下層數(shù)據(jù)，則點(diǎn)擊后下拉按鈕會消失。同時，你也可以提前告知 Tree 某個節(jié)點(diǎn)是否為葉子節(jié)點(diǎn)，從而避免在葉子節(jié)點(diǎn)前渲染下拉按鈕。

<template>
  <el-tree :props="props" :load="loadNode" lazy show-checkbox> </el-tree>
</template>

<script>
  export default {
    data() {
      return {
        props: {
          label: 'name',
          children: 'zones',
          isLeaf: 'leaf',
        },
      }
    },
    methods: {
      loadNode(node, resolve) {
        if (node.level === 0) {
          return resolve([{ name: 'region' }])
        }
        if (node.level > 1) return resolve([])

        setTimeout(() => {
          const data = [
            {
              name: 'leaf',
              leaf: true,
            },
            {
              name: 'zone',
            },
          ]

          resolve(data)
        }, 500)
      },
    },
  }
</script>

默認(rèn)展開和默認(rèn)選中

可將 Tree 的某些節(jié)點(diǎn)設(shè)置為默認(rèn)展開或默認(rèn)選中

分別通過default-expanded-keys和default-checked-keys設(shè)置默認(rèn)展開和默認(rèn)選中的節(jié)點(diǎn)。需要注意的是，此時必須設(shè)置node-key，其值為節(jié)點(diǎn)數(shù)據(jù)中的一個字段名，該字段在整棵樹中是唯一的。

<template>
  <el-tree
  :data="data"
  show-checkbox
  node-key="id"
  :default-expanded-keys="[2, 3]"
  :default-checked-keys="[5]"
  :props="defaultProps"
>
</el-tree>
</template>

<script>
  export default {
    data() {
      return {
        data: [
          {
            id: 1,
            label: '一級 1',
            children: [
              {
                id: 4,
                label: '二級 1-1',
                children: [
                  {
                    id: 9,
                    label: '三級 1-1-1',
                  },
                  {
                    id: 10,
                    label: '三級 1-1-2',
                  },
                ],
              },
            ],
          },
          {
            id: 2,
            label: '一級 2',
            children: [
              {
                id: 5,
                label: '二級 2-1',
              },
              {
                id: 6,
                label: '二級 2-2',
              },
            ],
          },
          {
            id: 3,
            label: '一級 3',
            children: [
              {
                id: 7,
                label: '二級 3-1',
              },
              {
                id: 8,
                label: '二級 3-2',
              },
            ],
          },
        ],
        defaultProps: {
          children: 'children',
          label: 'label',
        },
      }
    },
  }
</script>

禁用狀態(tài)

可將 Tree 的某些節(jié)點(diǎn)設(shè)置為禁用狀態(tài)

通過disabled設(shè)置禁用狀態(tài)。

<template>
  <el-tree
  :data="data"
  show-checkbox
  node-key="id"
  :default-expanded-keys="[2, 3]"
  :default-checked-keys="[5]"
>
</el-tree>
</template>

<script>
  export default {
    data() {
      return {
        data: [
          {
            id: 1,
            label: '一級 2',
            children: [
              {
                id: 3,
                label: '二級 2-1',
                children: [
                  {
                    id: 4,
                    label: '三級 3-1-1',
                  },
                  {
                    id: 5,
                    label: '三級 3-1-2',
                    disabled: true,
                  },
                ],
              },
              {
                id: 2,
                label: '二級 2-2',
                disabled: true,
                children: [
                  {
                    id: 6,
                    label: '三級 3-2-1',
                  },
                  {
                    id: 7,
                    label: '三級 3-2-2',
                    disabled: true,
                  },
                ],
              },
            ],
          },
        ],
        defaultProps: {
          children: 'children',
          label: 'label',
        },
      }
    },
  }
</script>

樹節(jié)點(diǎn)的選擇

本例展示如何獲取和設(shè)置選中節(jié)點(diǎn)。獲取和設(shè)置各有兩種方式：通過 node 或通過 key。如果需要通過 key 來獲取或設(shè)置，則必須設(shè)置node-key。

<template>
  <el-tree
  :data="data"
  show-checkbox
  default-expand-all
  node-key="id"
  ref="tree"
  highlight-current
  :props="defaultProps"
>
</el-tree>

<div class="buttons">
  <el-button @click="getCheckedNodes">通過 node 獲取</el-button>
  <el-button @click="getCheckedKeys">通過 key 獲取</el-button>
  <el-button @click="setCheckedNodes">通過 node 設(shè)置</el-button>
  <el-button @click="setCheckedKeys">通過 key 設(shè)置</el-button>
  <el-button @click="resetChecked">清空</el-button>
</div>
</template>

<script>
  export default {
    methods: {
      getCheckedNodes() {
        console.log(this.$refs.tree.getCheckedNodes())
      },
      getCheckedKeys() {
        console.log(this.$refs.tree.getCheckedKeys())
      },
      setCheckedNodes() {
        this.$refs.tree.setCheckedNodes([
          {
            id: 5,
            label: '二級 2-1',
          },
          {
            id: 9,
            label: '三級 1-1-1',
          },
        ])
      },
      setCheckedKeys() {
        this.$refs.tree.setCheckedKeys([3])
      },
      resetChecked() {
        this.$refs.tree.setCheckedKeys([])
      },
    },

    data() {
      return {
        data: [
          {
            id: 1,
            label: '一級 1',
            children: [
              {
                id: 4,
                label: '二級 1-1',
                children: [
                  {
                    id: 9,
                    label: '三級 1-1-1',
                  },
                  {
                    id: 10,
                    label: '三級 1-1-2',
                  },
                ],
              },
            ],
          },
          {
            id: 2,
            label: '一級 2',
            children: [
              {
                id: 5,
                label: '二級 2-1',
              },
              {
                id: 6,
                label: '二級 2-2',
              },
            ],
          },
          {
            id: 3,
            label: '一級 3',
            children: [
              {
                id: 7,
                label: '二級 3-1',
              },
              {
                id: 8,
                label: '二級 3-2',
              },
            ],
          },
        ],
        defaultProps: {
          children: 'children',
          label: 'label',
        },
      }
    },
  }
</script>

自定義節(jié)點(diǎn)內(nèi)容

節(jié)點(diǎn)的內(nèi)容支持自定義，可以在節(jié)點(diǎn)區(qū)添加按鈕或圖標(biāo)等內(nèi)容

可以通過兩種方法進(jìn)行樹節(jié)點(diǎn)內(nèi)容的自定義：render-content和 scoped slot。使用render-content指定渲染函數(shù)，該函數(shù)返回需要的節(jié)點(diǎn)區(qū)內(nèi)容即可。渲染函數(shù)的用法請參考 Vue 文檔。使用 scoped slot 會傳入兩個參數(shù)node和data，分別表示當(dāng)前節(jié)點(diǎn)的 Node 對象和當(dāng)前節(jié)點(diǎn)的數(shù)據(jù)。注意：由于 jsfiddle 不支持 JSX 語法，所以render-content示例在 jsfiddle 中無法運(yùn)行。但是在實(shí)際的項(xiàng)目中，只要正確地配置了相關(guān)依賴，就可以正常運(yùn)行。

<template>
  <div class="custom-tree-container">
  <div class="block">
    <p>使用 render-content</p>
    <el-tree
      :data="data"
      show-checkbox
      node-key="id"
      default-expand-all
      :expand-on-click-node="false"
      :render-content="renderContent"
    >
    </el-tree>
  </div>
  <div class="block">
    <p>使用 scoped slot</p>
    <el-tree
      :data="data"
      show-checkbox
      node-key="id"
      default-expand-all
      :expand-on-click-node="false"
    >
      <template #default="{ node, data }">
        <span class="custom-tree-node">
          <span>{{ node.label }}</span>
          <span>
            <a @click="append(data)"> Append </a>
            <a @click="remove(node, data)"> Delete </a>
          </span>
        </span>
      </template>
    </el-tree>
  </div>
</div>
</template>

<script>
  let id = 1000

  export default {
    data() {
      const data = [
        {
          id: 1,
          label: '一級 1',
          children: [
            {
              id: 4,
              label: '二級 1-1',
              children: [
                {
                  id: 9,
                  label: '三級 1-1-1',
                },
                {
                  id: 10,
                  label: '三級 1-1-2',
                },
              ],
            },
          ],
        },
        {
          id: 2,
          label: '一級 2',
          children: [
            {
              id: 5,
              label: '二級 2-1',
            },
            {
              id: 6,
              label: '二級 2-2',
            },
          ],
        },
        {
          id: 3,
          label: '一級 3',
          children: [
            {
              id: 7,
              label: '二級 3-1',
            },
            {
              id: 8,
              label: '二級 3-2',
            },
          ],
        },
      ]
      return {
        data: JSON.parse(JSON.stringify(data)),
      }
    },

    methods: {
      append(data) {
        const newChild = { id: id++, label: 'testtest', children: [] }
        if (!data.children) {
          data.children = []
        }
        data.children.push(newChild)
        this.data = [...this.data]
      },

      remove(node, data) {
        const parent = node.parent
        const children = parent.data.children || parent.data
        const index = children.findIndex((d) => d.id === data.id)
        children.splice(index, 1)
        this.data = [...this.data]
      },

      renderContent(h, { node, data, store }) {
        return h(
          'span',
          {
            class: 'custom-tree-node',
          },
          h('span', null, node.label),
          h(
            'span',
            null,
            h(
              'a',
              {
                onClick: () => this.append(data),
              },
              'Append '
            ),
            h(
              'a',
              {
                onClick: () => this.remove(node, data),
              },
              'Delete'
            )
          )
        )
      },
    },
  }
</script>
<style>
  .custom-tree-node {
    flex: 1;
    display: flex;
    align-items: center;
    justify-content: space-between;
    font-size: 14px;
    padding-right: 8px;
  }
</style>

    

節(jié)點(diǎn)過濾

通過關(guān)鍵字過濾樹節(jié)點(diǎn)

在需要對節(jié)點(diǎn)進(jìn)行過濾時，調(diào)用 Tree 實(shí)例的filter方法，參數(shù)為關(guān)鍵字。需要注意的是，此時需要設(shè)置filter-node-method，值為過濾函數(shù)。

<template>
  <el-input placeholder="輸入關(guān)鍵字進(jìn)行過濾" v-model="filterText"> </el-input>

<el-tree
  class="filter-tree"
  :data="data"
  :props="defaultProps"
  default-expand-all
  :filter-node-method="filterNode"
  ref="tree"
>
</el-tree>
</template>

<script>
  export default {
    watch: {
      filterText(val) {
        this.$refs.tree.filter(val)
      },
    },

    methods: {
      filterNode(value, data) {
        if (!value) return true
        return data.label.indexOf(value) !== -1
      },
    },

    data() {
      return {
        filterText: '',
        data: [
          {
            id: 1,
            label: '一級 1',
            children: [
              {
                id: 4,
                label: '二級 1-1',
                children: [
                  {
                    id: 9,
                    label: '三級 1-1-1',
                  },
                  {
                    id: 10,
                    label: '三級 1-1-2',
                  },
                ],
              },
            ],
          },
          {
            id: 2,
            label: '一級 2',
            children: [
              {
                id: 5,
                label: '二級 2-1',
              },
              {
                id: 6,
                label: '二級 2-2',
              },
            ],
          },
          {
            id: 3,
            label: '一級 3',
            children: [
              {
                id: 7,
                label: '二級 3-1',
              },
              {
                id: 8,
                label: '二級 3-2',
              },
            ],
          },
        ],
        defaultProps: {
          children: 'children',
          label: 'label',
        },
      }
    },
  }
</script>

手風(fēng)琴模式

對于同一級的節(jié)點(diǎn)，每次只能展開一個

<template>
  <el-tree
  :data="data"
  :props="defaultProps"
  accordion
  @node-click="handleNodeClick"
>
</el-tree>
</template>

<script>
  export default {
    data() {
      return {
        data: [
          {
            label: '一級 1',
            children: [
              {
                label: '二級 1-1',
                children: [
                  {
                    label: '三級 1-1-1',
                  },
                ],
              },
            ],
          },
          {
            label: '一級 2',
            children: [
              {
                label: '二級 2-1',
                children: [
                  {
                    label: '三級 2-1-1',
                  },
                ],
              },
              {
                label: '二級 2-2',
                children: [
                  {
                    label: '三級 2-2-1',
                  },
                ],
              },
            ],
          },
          {
            label: '一級 3',
            children: [
              {
                label: '二級 3-1',
                children: [
                  {
                    label: '三級 3-1-1',
                  },
                ],
              },
              {
                label: '二級 3-2',
                children: [
                  {
                    label: '三級 3-2-1',
                  },
                ],
              },
            ],
          },
        ],
        defaultProps: {
          children: 'children',
          label: 'label',
        },
      }
    },
    methods: {
      handleNodeClick(data) {
        console.log(data)
      },
    },
  }
</script>

可拖拽節(jié)點(diǎn)

通過 draggable 屬性可讓節(jié)點(diǎn)變?yōu)榭赏献А?/p>

<template>
  <el-tree
  :data="data"
  node-key="id"
  default-expand-all
  @node-drag-start="handleDragStart"
  @node-drag-enter="handleDragEnter"
  @node-drag-leave="handleDragLeave"
  @node-drag-over="handleDragOver"
  @node-drag-end="handleDragEnd"
  @node-drop="handleDrop"
  draggable
  :allow-drop="allowDrop"
  :allow-drag="allowDrag"
>
</el-tree>
</template>

<script>
  export default {
    data() {
      return {
        data: [
          {
            id: 1,
            label: '一級 1',
            children: [
              {
                id: 4,
                label: '二級 1-1',
                children: [
                  {
                    id: 9,
                    label: '三級 1-1-1',
                  },
                  {
                    id: 10,
                    label: '三級 1-1-2',
                  },
                ],
              },
            ],
          },
          {
            id: 2,
            label: '一級 2',
            children: [
              {
                id: 5,
                label: '二級 2-1',
              },
              {
                id: 6,
                label: '二級 2-2',
              },
            ],
          },
          {
            id: 3,
            label: '一級 3',
            children: [
              {
                id: 7,
                label: '二級 3-1',
              },
              {
                id: 8,
                label: '二級 3-2',
                children: [
                  {
                    id: 11,
                    label: '三級 3-2-1',
                  },
                  {
                    id: 12,
                    label: '三級 3-2-2',
                  },
                  {
                    id: 13,
                    label: '三級 3-2-3',
                  },
                ],
              },
            ],
          },
        ],
        defaultProps: {
          children: 'children',
          label: 'label',
        },
      }
    },
    methods: {
      handleDragStart(node, ev) {
        console.log('drag start', node)
      },
      handleDragEnter(draggingNode, dropNode, ev) {
        console.log('tree drag enter: ', dropNode.label)
      },
      handleDragLeave(draggingNode, dropNode, ev) {
        console.log('tree drag leave: ', dropNode.label)
      },
      handleDragOver(draggingNode, dropNode, ev) {
        console.log('tree drag over: ', dropNode.label)
      },
      handleDragEnd(draggingNode, dropNode, dropType, ev) {
        console.log('tree drag end: ', dropNode && dropNode.label, dropType)
      },
      handleDrop(draggingNode, dropNode, dropType, ev) {
        console.log('tree drop: ', dropNode.label, dropType)
      },
      allowDrop(draggingNode, dropNode, type) {
        if (dropNode.data.label === '二級 3-1') {
          return type !== 'inner'
        } else {
          return true
        }
      },
      allowDrag(draggingNode) {
        return draggingNode.data.label.indexOf('三級 3-2-2') === -1
      },
    },
  }
</script>

Attributes

props

?方法

Tree 內(nèi)部使用了 Node 類型的對象來包裝用戶傳入的數(shù)據(jù)，用來保存目前節(jié)點(diǎn)的狀態(tài)。 Tree 擁有如下方法：

Events

Scoped Slot