@vxe-ui/plugin-shortcut-key

Vxe UI plug-in, settings that provide shortcuts for keyboard operations.

Compatibility

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

Installing

npm install @vxe-ui/plugin-shortcut-key

// ...
// Use vxe-pc-ui
import { VxeUI } from 'vxe-pc-ui'
// Use vxe-table
// import { VxeUI } from 'vxe-table'
import VxeUIPluginShortcutKey from '@vxe-ui/plugin-shortcut-key'
// ...

VxeUI.use(VxeUIPluginShortcutKey, {
  // 表格快捷键监听
  tableListener: {
    'Ctrl + V' (params, evnt) {
      console.log('粘贴')
    }
  },
  // 功能键设置
  setting: {
    'pager.prevPage': 'ArrowLeft',
    'pager.nextPage': 'ArrowRight', // 单个按键
    'pager.prevJump': 'Shift + W',
    'pager.nextJump': 'Shift + S' // 组合键
  }
})

API

disabled 禁用快捷键

disabled: string[]

tableListener 表格快捷键监听

tableListener: { key: Function(params, event) }

setting 功能键设置

setting: { code: string }

| code 功能编码 | describe 描述 | key 参考键值 | |------|------|------| | table.edit.actived | 只对 edit-config 启用后有效，当单元格处于选中状态时，则进入编辑 | F2 | | table.edit.closed | 只对 edit-config 启用后有效，当单元格处于激活状态时，则退出编辑 | Esc | | table.edit.tab.leftMove | 只对 edit-config.mode=cell / mouse-config.selected 启用后有效，当单元格处于激活状态或者选中状态，则移动到左侧单元格 | Shift + Tab | | table.edit.tab.rightMove | 只对 edit-config.mode=cell / mouse-config.selected 启用后有效，当单元格处于激活状态或者选中状态，则移动到右侧单元格 | Tab | | table.edit.enter.upMove | 只对 edit-config.mode=cell / mouse-config.selected 启用后有效，当单元格处于激活状态或者选中状态，则移动到上面单元格 | Shift + Enter | | table.edit.enter.downMove | 只对 edit-config.mode=cell / mouse-config.selected 启用后有效，当单元格处于激活状态或者选中状态，则移动到下面单元格 | Enter | | table.cell.upMove | 只对 mouse-config.selected 启用后有效，当单元格处于选中状态，则移动到上面的单元格 | ArrowUp | | table.cell.downMove | 只对 mouse-config.selected 启用后有效，当单元格处于选中状态，则移动到下面的单元格 | ArrowDown | | table.cell.leftMove | 只对 mouse-config.selected 启用后有效，当单元格处于选中状态，则移动到左边的单元格 | ArrowLeft | | table.cell.rightMove | 只对 mouse-config.selected 启用后有效，当单元格处于选中状态，则移动到右边的单元格 | ArrowRight | | table.row.current.topMove | 只对 highlight-current-row 启用后有效，高亮行向上移动 | | | table.row.current.downMove | 只对 highlight-current-row 启用后有效，高亮行向上移动 | | | pager.prevPage | 只对 grid.pager-config 启用后有效，则进入上一页 | | | pager.nextPage | 只对 grid.pager-config 启用后有效，则进入下一页 | | | pager.prevJump | 只对 grid.pager-config 启用后有效，则向上翻页 | | | pager.nextJump | 只对 grid.pager-config 启用后有效，则向下翻页 | |

Contributors

Thank you to everyone who contributed to this project.

License

MIT © 2019-present, Xu Liangzhan