keylisten

键盘快捷监听分发

标签（空格分隔）： 未分类

---

一、功能列表

1. 事件监听

• 事件监听单例，防止多次触发
• 默认监听的keyup事件，暂不支持更改

2. 触发条件

• 配置条件
  • 1. inInput:光标在输入框内是否触发 true:触发，false:不触发，默认true
  • 2. needCtrl:是否需要同时按下ctrl键 不传，不限制 true:必须按下Ctrl false:不能按下Ctrl
  • 3. needShift:是否需要同时按下shift键
  • 4. needAlt:是否需要同时按下alt键 同needCtrl
  • 自定义方法
• 自定义方法
  • 传入自定义方法，在触发的时候，会执行该方法判断是否触发
  • 默认true，直接执行
• 事件触发执行
  • 多次绑定：同一件事件，后绑定的优先级更高
  • 事件冒泡：事件没有被响应，自动按绑定顺序冒泡
  • 事件互斥：同一事件，只会触发一次，捕获后，不再冒泡
  • 阻止默认行为：事件被捕获，默认行为将被阻止
• 事件定义
  • 内置常见事件： esc：取消 backspace：后退 enter:确认 delete:删除 up：向上 down:向下 increase：+ decrease：-
  • 支持自定义事件配置：优先级高于内置事件

二、使用方法

1. 安装

npm install @duomai/keylisten --save

2. 使用代码

import KeyListen from 'keyListen'
// 在created钩子里，使用内置事件，不需要setConfig
KeyListen.setConfig(config.shortcutKey).add({
  up: function () {
    // todo up
  },
  down: function () {
    // todo down
  }
})