vxe-table 实现撤销与重做：单元格编辑后支持 Ctrl+Z 回退

vxe-table 如何实现撤销与重做，修改单元格编辑后支持回退当公司业务需求需要实现编辑表格支持撤销功能，这时就可以通过设置 keyboard-config.isUndoRedo 启用。当编辑的单元格之后，按 Ctrl + Z | Command + Z 键，可以撤销会编辑之前的状态

需求场景

在表格编辑场景中，用户经常需要撤销误操作或重做已撤销的内容。vxe-table 提供了内置的撤销与重做功能，只需启用 keyboardConfig.isUndoRedo 即可获得类似 Excel 的编辑历史记录能力。

核心配置

在 vxe-grid 或 vxe-table 组件中，通过 keyboardConfig 开启撤销与重做：

javascript 复制代码

keyboardConfig: {
  isUndoRedo: true,   // 启用撤销与重做功能（Ctrl+Z / Ctrl+Y）
  // ... 其他键盘配置
}

示例代码

html 复制代码

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

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

const sexEditRender = reactive({
  name: 'VxeSelect',
  options: []
})

const gridOptions = reactive({
  border: true,
  height: 500,
  showOverflow: true,
  keepSource: true,
  columnConfig: {
    resizable: true
  },
  mouseConfig: {
    area: true // 是否开启区域选取
  },
  areaConfig: {
    multiple: true // 是否启用多区域选取功能
  },
  editConfig: {
    mode: 'cell', // 单元格编辑模式
    trigger: 'dblclick', // 双击单元格激活编辑状态
    showStatus: true // 显示编辑状态
  },
  keyboardConfig: {
    arrowCursorLock: true, // 方向键光标锁，开启后处于非聚焦式编辑状态，将支持在编辑状态中通过方向键切换单元格。（切换为聚焦编辑状态，可以按 F2 键或者鼠标左键点击输入框，就可以用方向键左右移动输入框的光标）
    isClip: true, // 是否开启复制粘贴
    isArrow: true, // 是否开启方向键功能
    isShift: true, // 是否开启同时按住方向键以活动区域为起始，向指定方向扩展单元格区域
    isTab: true, // 是否开启 Tab 键功能
    isEnter: true, // 是否开启回车键功能
    isEdit: true, // 是否开启任意键进入编辑（功能键除外）
    isBack: true, // 是否开启 Backspace 键功能
    isDel: true, // 是否开启删除键功能
    isEsc: true, // 是否开启Esc键关闭编辑功能
    isFNR: true, // 是否开启查找与替换
    isMerge: true, // 是否开启单元格合并功能
    isChecked: true, // 是否启用复选框/单选框按空格键选中/取消功能
    isUndoRedo: true // 是否启用撤销与重做功能
  },
  columns: [
    { type: 'seq', fixed: 'left', width: 60 },
    { type: 'checkbox', fixed: 'left', width: 60 },
    { field: 'name', title: 'name', width: 200, editRender: { name: 'VxeInput' } },
    { field: 'role', title: 'Role', width: 200, editRender: { name: 'VxeInput' } },
    { field: 'sex', title: 'sex', width: 250, editRender: sexEditRender },
    { field: 'num1', title: 'Num1', width: 200, editRender: { name: 'VxeInput' } },
    { field: 'num2', title: 'Num2', width: 250, editRender: { name: 'VxeInput' } },
    { field: 'num3', title: 'Num3', width: 300, editRender: { name: 'VxeInput' } },
    { field: 'age', title: 'age', width: 100, editRender: { name: 'VxeInput' } },
    { field: 'address', title: 'Address', fixed: 'right', width: 300, editRender: { name: 'VxeInput' } }
  ],
  data: [
    { id: 10001, name: 'Test1', role: 'Develop', sex: '1', num1: 12, num2: 21, num3: 78, age: 28, address: 'Shengzhen' },
    { id: 10002, name: 'Test2', role: 'Test', sex: '0', num1: 23, num2: 45, num3: 23, age: 22, address: 'Guangzhou' },
    { id: 10003, name: 'Test3', role: 'PM', sex: '1', num1: 23, num2: 12, num3: 68, age: 32, address: 'Shanghai' },
    { id: 10004, name: 'Test4', role: 'Designer', sex: '0', num1: 23, num2: 23, num3: 47, age: 24, address: 'Shanghai' },
    { id: 10005, name: 'Test5', role: 'Designer', sex: '0', num1: 32, num2: 77, num3: 65, age: 42, address: 'Guangzhou' },
    { id: 10006, name: 'Test6', role: 'Designer', sex: '1', num1: 39, num2: 66, num3: 87, age: 38, address: 'Shengzhen' },
    { id: 10007, name: 'Test7', role: 'Test', sex: '0', num1: 23, num2: 44, num3: 23, age: 24, address: 'Shengzhen' },
    { id: 10008, name: 'Test8', role: 'PM', sex: '1', num1: 23, num2: 23, num3: 87, age: 34, address: 'Shanghai' },
    { id: 10009, name: 'Test9', role: 'Designer', sex: '1', num1: 91, num2: 23, num3: 24, age: 52, address: 'Shanghai' },
    { id: 10010, name: 'Test10', role: 'Test', sex: '0', num1: 20, num2: 72, num3: 54, age: 44, address: 'Guangzhou' },
    { id: 10011, name: 'Test11', role: 'Designer', sex: '1', num1: 56, num2: 32, num3: 63, age: 52, address: 'Shanghai' },
    { id: 10012, name: 'Test12', role: 'Test', sex: '0', num1: 34, num2: 65, num3: 54, age: 47, address: 'Guangzhou' },
    { id: 10013, name: 'Test13', role: 'Test', sex: '0', num1: 39, num2: 65, num3: 435, age: 47, address: 'Guangzhou' },
    { id: 10014, name: 'Test14', role: 'Test', sex: '0', num1: 44, num2: 65, num3: 324, age: 45, address: 'Guangzhou' },
    { id: 10015, name: 'Test15', role: 'Test', sex: '0', num1: 45, num2: 56, num3: 54, age: 39, address: 'Guangzhou' },
    { id: 10016, name: 'Test16', role: 'Test', sex: '0', num1: 34, num2: 65, num3: 344, age: 44, address: 'Shanghai' },
    { id: 10017, name: 'Test17', role: 'Test', sex: '0', num1: 78, num2: 77, num3: 78, age: 48, address: 'Guangzhou' },
    { id: 10018, name: 'Test18', role: 'Test', sex: '0', num1: 32, num2: 12, num3: 45, age: 89, address: 'Shanghai' },
    { id: 10019, name: 'Test19', role: 'Test', sex: '0', num1: 42, num2: 65, num3: 8, age: 52, address: 'Guangzhou' },
    { id: 10020, name: 'Test20', role: 'Test', sex: '0', num1: 56, num2: 45, num3: 4, age: 41, address: 'Shanghai' },
    { id: 10021, name: 'Test21', role: 'Test', sex: '1', num1: 48, num2: 65, num3: 54, age: 49, address: 'Guangzhou' },
    { id: 10022, name: 'Test22', role: 'Test', sex: '0', num1: 41, num2: 65, num3: 12, age: 50, address: 'Shanghai' }
  ]
})
// 异步加载下拉选项
setTimeout(() => {
  sexEditRender.options = [
    { label: 'Man', value: '1' },
    { label: 'Women', value: '0' }
  ]
}, 300)
</script>

关键配置说明

必须启用的基础配置

keepSource: true：保留原始数据副本，撤销/重做依赖于此。
editConfig.mode: 'cell'：单元格编辑模式（也支持行编辑模式，但撤销/重做对单元格编辑体验更好）。

当 isUndoRedo: true 时，vxe-table 内部会维护一个编辑历史栈：每次单元格编辑完成后（失焦或按回车），当前数据快照会被推入历史栈。按 Ctrl+Z 时，从历史栈中弹出上一个状态并恢复。按 Ctrl+Y 时，执行重做操作（需先有撤销操作）。

获取历史记录 API

javascript 复制代码

// 获取表格实例
const $grid = gridRef.value

// 手动撤销
$grid.undo()

// 手动重做
$grid.redo()

vxe-table 的撤销/重做功能开箱即用，无需额外存储逻辑，极大降低了开发成本。如果你的业务需要严谨的编辑历史管理，这是一个非常实用的特性。

vxetable.cn