当前位置：首页 > article >正文

vxe-table 树形表格的详细用法、树形表格懒加载

article 2024/12/2 7:02:53

vxe-table 树形表格的使用，支持多种数据结构，可以是带有父子结构的数组，也可以带有层级结构的嵌套数据。

官网：https://vxetable.cn

Gitee

带有父子结构的平级数据

只需要带有父子结构的平级数据，例如：id 和 parentId，字段名可以任意设置。对于保存到数据库的平级数据非常方便，无需转换就能渲染。

<template>
  <div>
    <vxe-grid v-bind="gridOptions"></vxe-grid>
  </div>
</template>

<script setup>
import { reactive } from 'vue'

const gridOptions = reactive({
  border: true,
  treeConfig: {
    transform: true,
    rowField: 'id',
    parentField: 'parentId'
  },
  columns: [
    { type: 'seq', width: 70 },
    { field: 'name', title: 'Name', minWidth: 300, treeNode: true },
    { field: 'size', title: 'Size' },
    { field: 'type', title: 'Type' },
    { field: 'date', title: 'Date' }
  ],
  data: [
    { id: 10000, parentId: null, name: 'Test1', type: 'mp3', size: 1024, date: '2020-08-01' },
    { id: 10050, parentId: null, name: 'Test2', type: 'mp4', size: 0, date: '2021-04-01' },
    { id: 24300, parentId: 10050, name: 'Test3', type: 'avi', size: 1024, date: '2020-03-01' },
    { id: 20045, parentId: 24300, name: 'Test4', type: 'html', size: 600, date: '2021-04-01' },
    { id: 10053, parentId: 24300, name: 'Test5', type: 'avi', size: 0, date: '2021-04-01' },
    { id: 24330, parentId: 10053, name: 'Test6', type: 'txt', size: 25, date: '2021-10-01' },
    { id: 21011, parentId: 10053, name: 'Test7', type: 'pdf', size: 512, date: '2020-01-01' },
    { id: 22200, parentId: 10053, name: 'Test8', type: 'js', size: 1024, date: '2021-06-01' },
    { id: 23666, parentId: null, name: 'Test9', type: 'xlsx', size: 2048, date: '2020-11-01' },
    { id: 23677, parentId: 23666, name: 'Test10', type: 'js', size: 1024, date: '2021-06-01' },
    { id: 23671, parentId: 23677, name: 'Test11', type: 'js', size: 1024, date: '2021-06-01' },
    { id: 23672, parentId: 23677, name: 'Test12', type: 'js', size: 1024, date: '2021-06-01' },
    { id: 23688, parentId: 23666, name: 'Test13', type: 'js', size: 1024, date: '2021-06-01' },
    { id: 23681, parentId: 23688, name: 'Test14', type: 'js', size: 1024, date: '2021-06-01' },
    { id: 23682, parentId: 23688, name: 'Test15', type: 'js', size: 1024, date: '2021-06-01' },
    { id: 24555, parentId: null, name: 'Test16', type: 'avi', size: 224, date: '2020-10-01' },
    { id: 24566, parentId: 24555, name: 'Test17', type: 'js', size: 1024, date: '2021-06-01' },
    { id: 24577, parentId: 24555, name: 'Test18', type: 'js', size: 1024, date: '2021-06-01' }
  ]
})
</script>

带有层级结构的嵌套数据

渲染带有层级结构的数据，例如 children 存放子节点

<template>
  <div>
    <vxe-grid v-bind="gridOptions"></vxe-grid>
  </div>
</template>

<script setup>
import { reactive } from 'vue'

const gridOptions = reactive({
  border: true,
  treeConfig: {
    rowField: 'id',
    childrenField: 'children'
  },
  columns: [
    { type: 'seq', width: 70 },
    { field: 'name', title: 'Name', minWidth: 300, treeNode: true },
    { field: 'size', title: 'Size' },
    { field: 'type', title: 'Type' },
    { field: 'date', title: 'Date' }
  ],
  data: [
    { id: 10000, name: 'Test1', type: 'mp3', size: 1024, date: '2020-08-01' },
    {
      id: 10050,
      name: 'Test2',
      type: 'mp4',
      size: 0,
      date: '2021-04-01',
      children: [
        {
          id: 24300,
          name: 'Test3',
          type: 'avi',
          size: 1024,
          date: '2020-03-01',
          children: [
            { id: 20045, name: 'Test4', type: 'html', size: 600, date: '2021-04-01' },
            {
              id: 10053,
              name: 'Test5',
              type: 'avi',
              size: 0,
              date: '2021-04-01',
              children: [
                { id: 24330, name: 'Test6', type: 'txt', size: 25, date: '2021-10-01' },
                { id: 21011, name: 'Test7', type: 'pdf', size: 512, date: '2020-01-01' },
                { id: 22200, name: 'Test8', type: 'js', size: 1024, date: '2021-06-01' }
              ]
            }
          ]
        }
      ]
    },
    {
      id: 23666,
      name: 'Test9',
      type: 'xlsx',
      size: 2048,
      date: '2020-11-01',
      children: [
        {
          id: 23677,
          name: 'Test10',
          type: 'js',
          size: 1024,
          date: '2021-06-01',
          children: [
            { id: 23671, name: 'Test11', type: 'js', size: 1024, date: '2021-06-01' },
            { id: 23672, name: 'Test12', type: 'js', size: 1024, date: '2021-06-01' }
          ]
        },
        {
          id: 23688,
          name: 'Test13',
          type: 'js',
          size: 1024,
          date: '2021-06-01',
          children: [
            { id: 23681, name: 'Test14', type: 'js', size: 1024, date: '2021-06-01' },
            { id: 23682, name: 'Test15', type: 'js', size: 1024, date: '2021-06-01' }
          ]
        }
      ]
    },
    {
      id: 24555,
      name: 'Test16',
      type: 'avi',
      size: 224,
      date: '2020-10-01',
      children: [
        { id: 24566, name: 'Test17', type: 'js', size: 1024, date: '2021-06-01' },
        { id: 24577, name: 'Test18', type: 'js', size: 1024, date: '2021-06-01' }
      ]
    }
  ]
})
</script>

树形懒加载

在这里插入图片描述

只需要给数据打上标识 hasChild=true，就说明该数据存在子节点，就会出现展开按钮，点击后就能加载下级节点

<template>
  <div>
    <vxe-table
      border
      :row-config="{keyField: 'id'}"
      :column-config="{resizable: true}"
      :tree-config="treeConfig"
      :data="tableData">
      <vxe-column type="seq" width="70"></vxe-column>
      <vxe-column field="name" title="Name" width="400" tree-node></vxe-column>
      <vxe-column field="size" title="Size"></vxe-column>
      <vxe-column field="type" title="Type"></vxe-column>
      <vxe-column field="date" title="Date"></vxe-column>
    </vxe-table>
  </div>
</template>

<script setup>
import { ref, reactive } from 'vue'

const tableData = ref([
  { id: 10000, parentId: null, name: 'test abc1', type: 'mp3', size: 1024, date: '2020-08-01' },
  { id: 10050, parentId: null, name: 'Test2', type: 'mp4', size: 0, date: '2021-04-01', hasChild: true },
  { id: 23666, parentId: null, name: 'Test23', type: 'mp4', size: 0, date: '2021-01-02', hasChild: true },
  { id: 24555, parentId: null, name: 'test abc9', type: 'avi', size: 224, date: '2020-10-01' }
])

// 模拟后台
const fetchChildListApi = (parentRow) => {
  return new Promise(resolve => {
    setTimeout(() => {
      const childs = [
        { id: parentRow.id + 1000000, parentId: parentRow.id, name: parentRow.name + 'Test111111111111', type: 'mp4', size: 0, date: '2021-10-03', hasChild: true },
        { id: parentRow.id + 1500000, parentId: parentRow.id, name: parentRow.name + 'Test222222222222', type: 'mp3', size: 0, date: '2021-07-09', hasChild: false }
      ]
      resolve(childs)
    }, 500)
  })
}

const treeConfig = reactive({
  transform: true,
  rowField: 'id',
  parentField: 'parentId',
  lazy: true,
  hasChild: 'hasChild',
  loadMethod ({ row }) {
    // 异步加载子节点
    return fetchChildListApi(row)
  }
})
</script>