@vxe-ui/plugin-menu

Vxe UI plug-in supports context menu.

Compatibility

It corresponds to vxe-table v4 or vxe-pc-ui v4

Installing

npm install @vxe-ui/plugin-menu

// ...
// Use vxe-pc-ui
import { VxeUI } from 'vxe-pc-ui'
// Use vxe-table
// import { VxeUI } from 'vxe-table'
import VxeUIPluginMenu from '@vxe-ui/plugin-menu'
// ...

VxeUI.use(VxeUIPluginMenu)

API

Context menu codes

| code 编码 | describe 描述 | params 参数 | |------|------|------| | SYSTEM_PAGE_REFRESH | 刷新页面（对应按键F5） | — | | SYSTEM_PAGE_FORWARD | 页面前进 | — | | SYSTEM_PAGE_BACK | 页面后退 | — | | CLEAR_CELL | 清除单元格数据的值；如果启用 mouse-config.area 功能，则清除区域范围内的单元格数据 | — | | CLEAR_ROW | 清除行数据的值 | — | | CLEAR_CHECKBOX_ROW | 清除复选框选中行数据的值 | — | | CLEAR_AREA_ROW | 如果启用 mouse-config.area 功能，清除区域选择范围内数据的值，否则清除行数据的值 | — | | CLEAR_ALL | 清除所有数据的值 | — | | SELECT_ALL_AREA | 如果启用 mouse-config.area 功能，选择所有单元格 | — | | SELECT_AREA_TO_LEFT | 如果启用 mouse-config.area 功能，以当前单元格为起点，范围选取到左侧单元格 | — | | SELECT_AREA_TO_RIGHT | 如果启用 mouse-config.area 功能，以当前单元格为起点，范围选取到右侧单元格 | — | | SELECT_AREA_TO_TOP | 如果启用 mouse-config.area 功能，以当前单元格为起点，范围选取到顶部单元格 | — | | SELECT_AREA_TO_BOTTON | 如果启用 mouse-config.area 功能，以当前单元格为起点，范围选取到底部单元格 | — | | REVERT_CELL | 还原单元格数据的值；如果启用 mouse-config.area 功能，则还原区域范围内的单元格数据 | — | | REVERT_ROW | 还原行数据的值 | — | | REVERT_CHECKBOX_ROW | 还原复选框选中行数据的值 | — | | REVERT_ALL | 还原所有数据的值 | — | | MERGE_OR_CLEAR | 如果启用 mouse-config.area 功能，如果所选区域内已存在合并单元格，则取消临时合并，否则临时合并 | — | | MERGE_CELL | 如果启用 mouse-config.area 功能，临时合并区域范围内的单元格，不管是否存在已合并 | — | | CLEAR_MERGE_CELL | 如果启用 mouse-config.area 功能，清除区域范围内单元格的临时合并状态 | — | | CLEAR_ALL_MERGE | 清除所有单元格及表尾的临时合并状态 | — | | COPY_TITLE | 复制列头标题 | — | | COPY_CELL | 复制单元格数据的值；如果启用 mouse-config.area 功能，则复制区域范围内的单元格数据，支持 Excel 和 WPS | — | | CUT_CELL | 剪贴单元格数据的值；如果启用 mouse-config.area 功能，则剪贴区域范围内的单元格数据，支持 Excel 和 WPS | — | | PASTE_CELL | （仅支持在单表区域内操作）粘贴从表格中被复制的数据；如果启用 mouse-config.area 功能，则粘贴区域范围内的单元格数据，不支持读取剪贴板 | — | | EDIT_CELL | 编辑选中单元格 | — | | EDIT_ROW | 编辑选中行并激活选中单元格 | — | | INSERT_ROW | 顶部插入单行数据 | record | | INSERT_EDIT_ROW | 顶部插入单行数据并激活编辑状态 | Array<record, field> | | INSERT_AT_ROW | 插入单行数据到指定位置 | record | | BATCH_INSERT_AT_ROW | 插入多行数据到指定位置 | record | | INSERT_NEXT_AT_ROW | 插入单行数据到指定位置 | record | | BATCH_INSERT_NEXT_AT_ROW | 插入多行数据到指定位置 | record | | INSERT_AT_EDIT_ROW | 插入单行数据到指定位置并激活编辑状态 | Array<record, field> | | BATCH_INSERT_AT_EDIT_ROW | 插入多行数据到指定位置并激活编辑状态 | Array<record, field> | | INSERT_NEXT_AT_EDIT_ROW | 插入单行数据到指定位置并激活编辑状态 | Array<record, field> | | BATCH_INSERT_NEXT_AT_EDIT_ROW | 插入多行数据到指定位置并激活编辑状态 | Array<record, field> | | DELETE_ROW | 移除行数据 | — | | DELETE_AREA_ROW | 如果启用 mouse-config.area 功能，移除所选区域行数据；否则删除当前行 | — | | DELETE_CHECKBOX_ROW | 移除复选框选中行数据 | — | | DELETE_ALL | 移除所有行数据 | — | | CLEAR_SORT | 清除所选列排序条件 | — | | CLEAR_ALL_SORT | 清除所有排序条件 | — | | SORT_ASC | 按所选列的值升序 | — | | SORT_DESC | 按所选列的值倒序 | — | | CLEAR_FILTER | 清除选中列的筛选条件 | — | | CLEAR_ALL_FILTER | 清除所有列筛选条件 | — | | FILTER_CELL | 根据单元格值筛选 | — | | EXPORT_ROW | 导出行数据 | options | | EXPORT_CHECKBOX_ROW | 导出复选框选中行数据 | options | | EXPORT_ALL | 导出所有行数据 | options | | PRINT_ALL | 打印所有行数据 | options | | PRINT_CHECKBOX_ROW | 打印复选框选中行 | options | | OPEN_FIND | 如果启用 mouse-config.area 功能，打开单元格查找功能 | — | | OPEN_REPLACE | 如果启用 mouse-config.area 功能，打开单元格替换功能 | — | | FIXED_LEFT_COLUMN | 将列固定到左侧 | — | | FIXED_RIGHT_COLUMN | 将列固定到右侧 | — | | CLEAR_FIXED_COLUMN | 清除固定列 | — | | HIDDEN_COLUMN | 隐藏当前列 | — | | RESET_COLUMN | 重置列的可视状态 | — | | RESET_RESIZABLE | 重置列宽状态 | — | | RESET_ALL | 重置列的所有状态 | — | | COMMIT_PROXY_INITIAL | 仅支持 vxe-grid，用于 proxy-config，重新初始化，恢复到初始状态，触发对应的 ajax.query | — | | COMMIT_PROXY_QUERY | 仅支持 vxe-grid，用于 proxy-config，重新加载，如果有分页，返回第一页，触发对应的 ajax.query | — | | COMMIT_PROXY_RELOAD | 仅支持 vxe-grid，用于 proxy-config，刷新当前页，触发对应的 ajax.query | — | | COMMIT_PROXY_DELETE | 仅支持 vxe-grid，用于 proxy-config，直接删除，触发对应的 ajax.delete | — | | COMMIT_PROXY_SAVE | 仅支持 vxe-grid，用于 proxy-config，保存数据，触发对应的 ajax.save | — |

Table Demo

<template>
  <vxe-table
    :data="tableData"
    :menu-config="menuConfig"
    :edit-config="{trigger: 'click', mode: 'cell'}">
    <vxe-column type="seq" width="60"></vxe-column>
    <vxe-column field="name" title="Name" :edit-render="{name: 'input'}"></vxe-column>
    <vxe-column field="sex" title="sex" :edit-render="{name: 'input'}"></vxe-column>
    <vxe-column field="age" title="Age" :edit-render="{name: 'input'}"></vxe-column>
  </vxe-table>
</template>

<script>
export default {
  data () {
    return {
      tableData: [
        { id: 100,  name: 'test1', age: 28, sex: '1' },
        { id: 101,  name: 'test2', age: 32, sex: '0' },
        { id: 102,  name: 'test3', age: 36, sex: '1' }
      ],
      menuConfig: {
        body: {
          options: [
            [
              { code: 'EXPORT_ALL', name: '导出.csv' },
              { code: 'INSERT_EDIT_ROW', name: '新增' }
            ]
          ]
        }
      }
    }
  }
}
</script>

Contributors

Thank you to everyone who contributed to this project.

License

MIT © 2019-present, Xu Liangzhan