vxe-gantt甘特图在Nuxt.js中的集成与使用全过程详解教程

vxe-gantt 是一个功能强大的 Vue 甘特图组件库，在项目进度管理、任务排期这类场景里特别好用。不过话说回来，它跟大多数 UI 组件库一样，强依赖浏览器 DOM 环境——这意味着，它没法在服务端渲染（SSR）时直接跑起来。如果你正在用 Nuxt 4 开发项目，想把它集成进去，就得借助官方提供的 Nuxt 模块，并且得把组件放在 里面，保证它只在客户端加载。

下面这篇指南会从安装、模块配置到具体使用，一步步讲清楚，帮你快速在 Nuxt 4 项目里把甘特图组件用起来。

安装

先把依赖装上。执行下面这条命令，安装 vxe-gantt 以及它依赖的 UI 库、表格核心库，还有对应的 Nuxt 模块：

npm install vxe-pc-ui vxe-table vxe-gantt vxe-pc-ui-nuxt vxe-gantt-nuxt -D

配置 Nuxt 模块

安装完事儿之后，接下来要配置一下。因为 vxe-gantt 内部大量调用了浏览器 API——比如鼠标拖拽、DOM 尺寸计算、ResizeObserver 这些——所以服务端渲染这一步肯定过不去。这也是为什么所有用到甘特图组件的地方，都必须用 标签包起来。

// ...
export default defineNuxtConfig({
  // ...
  modules: [
     // ...
    'vxe-pc-ui-nuxt',
    'vxe-gantt-nuxt',
    'vxe-table-nuxt',
    // ...
  ],
  vxeBaseSetting: {
    // global: true // 是否全局加载，如果 false 则按需加载
  },
  vxeTableSetting: {
    // global: true // 是否全局加载，如果 false 则按需加载
  },
  vxeGanttSetting: {
    // global: true // 是否全局加载，如果 false 则按需加载
  },
  // ...
})

这里要注意，global: true 的意思是全局加载所有组件，如果设置为 false，那就按需加载。这个看你的项目需求来定就行。

使用

配置搞定之后，就可以在组件里直接用了。vxe-gantt 支持 Client 模式，下面是完整的示例代码：

<template>
  <ClientOnly>
    <vxe-gantt v-bind="ganttOptions">vxe-gantt>
  ClientOnly>
template><script setup>
import { reactive } from 'vue'const ganttOptions = reactive({
  border: true,
  height: 200,
  columns: [
    { field: 'name', title: '任务名称', minWidth: 200 },
    { field: 'start', title: '开始时间', width: 100 },
    { field: 'end', title: '结束时间', width: 100 }
  ],
  data: [
    { id: 10001, name: 'A项目', start: '2024-03-01', end: '2024-03-04', progress: 3 },
    { id: 10002, name: '城市道路修理进度', start: '2024-03-03', end: '2024-03-08', progress: 10 },
    { id: 10003, name: 'B大工程', start: '2024-03-03', end: '2024-03-11', progress: 90 },
    { id: 10004, name: '超级大工程', start: '2024-03-05', end: '2024-03-11', progress: 15 },
    { id: 10005, name: '地球净化项目', start: '2024-03-08', end: '2024-03-15', progress: 100 },
    { id: 10006, name: '一个小目标项目', start: '2024-03-10', end: '2024-03-21', progress: 5 },
    { id: 10007, name: '某某计划', start: '2024-03-15', end: '2024-03-24', progress: 70 },
    { id: 10008, name: '某某科技项目', start: '2024-03-20', end: '2024-03-29', progress: 50 },
    { id: 10009, name: '地铁建设工程', start: '2024-03-19', end: '2024-03-20', progress: 5 },
    { id: 10010, name: '铁路修建计划', start: '2024-03-12', end: '2024-03-20', progress: 10 }
  ]
})
script>

这个示例里定义了一个甘特图配置对象 ganttOptions，里面包含了表格的边框、高度，以及任务名称、开始时间、结束时间这些列，还有几条示例数据。你完全可以根据自己的业务场景来调整这些字段和数据。