@bytedo/keyboard

JS键盘热键

支持各种按钮组合。原生js开发, 无任何依赖(不到2KB)。使用也非常简单。

1.x版 功能键(Shift, Ctrl, Alt/Option, Win/Cmd)不区分左右。

使用

键盘

import Keyboard from 'http://unpkg.bytedo.org/@bytedo/keyboard/dist/index.js'

var kb = new Keyboard()
// 默认整个document监听, 也可以单独对局部起效
// var kb = new Keyboard(document.querySelector('.foo'))

// 同时按Ctrl键和C键, 触发回调
kb.on(['ctrl + c'], ev => {
  // todo...
})

// 分别按下 Ctrl + C键, 然后再 300毫秒内按下Ctrl + V键, 触发回调
kb.on(['ctrl + c', 'ctrl + v'], ev => {
  // todo...
})

辅助功能键

辅助功能键, 不支持单独设置热键。

包括 Ctrl、Shift、Alt/Option、Win/Cmd 这4个。

普通按键

即除了辅助功能键以外的其他按键。可以单独设置, 也可以配合辅助按键组合使用。

但是, 不允许在一组里出现多次。如需要, 请分组。

var kb = new Keyboard()

// 同时出现C和V这2个普通按键, 是不允许的,
kb.on(['ctrl + c + v'], ev => {
  // todo...
})

// 须改成分2组写
kb.on(['ctrl + c', 'ctrl + v'], ev => {
  // todo...
})

API

• .disabled

禁止属性, 允许临时暂时热键.

• .on(actions<Array>, callback<Function>)

监听键盘动作组合, 支持单组或双组。

双组时, 2组按键前后时差不能超过300毫秒, 否则视为2次独立的操作。 键名不区分大小写

• .off(actions<Array>, callback<Function>)

移除键盘监听。

• .destroy()

销毁整个键盘监听。

• .finally(callback<Function>)

类似Promise.finally, 只要有按键被按下(除了纯辅助功能键外), 都会触发回调.

键名对照表

键名不区别大小写, 内部统一转为小写。