hotkey-trigger

hotkey-trigger 是一个帮助你监听键盘按键并且触发事件动作的插件，它可以完成事件触发动作编排， 按键操作权限控制。插件通过元素选择器来获取触发事件，不会入侵你原有的代码。

使用

• 安装

npm install hotkey-trigger

• 引入

import hotKey from 'hotkey-trigger';

• 使用

const trigger = hotKey({
  keys: ['a', 's', 'd'],
  log: true,
  pressed(event) {
    trigger.action(event.key);
  }
});

trigger.register('a')('body')(['.button']);

上面是简单的使用，通过keys参数传入需要监听的按键名，在pressed 方法中触发动作， 最后我们为按键a注册触发的元素节点。

API

属性	说明	类型	默认值
keys	需要被监听的键盘按键名	string[]	-
pressed	按键被按下后触发的回调	function(event)
log	控制台是否输入按键日志	boolean	false
handler	全局(window)挂载方法生成后的操作器句柄名	string
filter	是否在输入框等触发按键，具体用法见下	function(event): boolean
clickBefore	触发事件点击前的回调方法	function(keyName, node: QueryNodeType)
hotKeyConfig	快捷键触发动作配置，具体用法见下	object	-
operationControl	快捷键操作权限控制配置，具体用法见下	object	-

方法及属性

方法or属性	说明	类型
action	触发事件动作的方法，参数keyName为按键名，callback(node, index, keyName)为动作触发时的回调方法，isPolling为是否需要启用元素轮询查询	function(keyName: string, callback?: (node, index, keyName) => void, poll?: boolean)
find	dom节点查询方法，参数selector为选择器名，isNew为是否断开节点查询的上下文，polling是否启用轮询查询元素节点，方法会返回一个元素的包装对象，方便链式编程	function(selector: string, isNew: boolean | void, polling?: boolean)
bind	动态绑定新的按键以及事件	function(keys: string[], callBack: (event) => void)
unbind	解除绑定按键	function(keys: string[])
register	注册对应按键上的触发事件节点	function(keyName: string)(containerName: string)(className: string)
unRegister	注销快捷键事件	function(keyName: string)
setFocusId	手动设置当前的焦点区ID	function(id: string)
getFocusId	获取当前的焦点区ID	function()
setFocus	设置当前焦点的容器，会在要设置的容器节点上添加一个hot-key-focus-container类名，全局只会存在一个焦点容器	function(target: HTMLElement)
clearFocus	清除焦点的容器	function()
keys	被监听的键盘按键名集合	string[]
hotKeyConfig	快捷键触发动作配置	object
operationControl	快捷键操作权限控制配置	object

快捷键触发动作配置

hotKeyConfig 参数用于配置快捷键触发所对应的元素节点的事件，它是一个对象结构。

• hotKeyConfig中的键名为触发的快捷键名称。
• operation是触发按键事件的节点选择器名，它是一个数组结构。当为一个普通的数组时，如果数组 内存在多项，这些元素节点上的事件会被依次触发。当它为一个二维数组时，快捷键触发其中一项里的事件后 则不会再继续执行其他元素的事件。
• dynamic 是一个boolean值，当将其设置为true时，快捷键不会再寻找operation参数下的元素节点。 它用于触发一些动态按键事件。你可能会在不同 的窗口或者元素容器中会触发所不同的按键事件，在operationControl(见下文) 的配置中你可以为动态按键配置触发的元素选择器。

快捷键操作权限控制配置

operationControl参数用于对快捷键操作进行权限控制，当你在一些操作中不期望能够触发另一些快捷键时，这时权限控制就很有用。

• hotKeyConfig中的键名为控制权限区域的id，在不同的操作区你可能需要区分不同的id用以控制权限。
• control 用于划分可触发快捷键，当它为字符串ALL时代表在当前操作区中你可以触发所有的快捷键。你如果需要控制只触发部分的快捷键， 你需要将其设置为一个数组，数组中的每一项即为你可触发的快捷键键名。
• dynamicSelector 用于配置动态快捷键所触发的元素，它是一个对象结构。其中键名为你要触发的快捷键名称，值为所触发元素的选择器。 你可以在不同的操作区配置各种需要触发的动态快捷键元素选择器。