shortcut-key-js/README.md

js按键,组合键监听

## Describe

js 按键监听支持组合按键监听

## Installation

```
$ npm install shortcut-key-js
```

## API

```js
import pressKey from 'shortcut-key-js';

const searchListener = function (evt) {
	console.log('ctrl+f快捷键触发');
};
// 注册一组快捷键
pressKey.on('ctrl+f', searchListener);
// 移除一组快捷键监听,当快捷键不需要使用时请使用off移除监听
// pressKey.off('ctrl+f', searchListener);
```

### 额外的扩展参数

扩展参数并不是必须的,但我们可以根据自身需要调整

```
{
  // 控制按键监听的方式
  type: 'keydown',
  // 组合键,键与键之间的分隔符号,请勿设置任何空白字符作为分隔符,注册时任何\s字符将会被移除
  separator: '+',
  // 需要在指定的dom节点上监听
  target: document,
  // 是否禁用表单控件的按键监听(input, textarea)
  disableInInput: true,
  // 是否停止事件继续传播
  stopPropagation: true,
  // 是否禁用系统默认事件响应
  preventDefault: true
}
```

## Supported Modifier keys

`ctrl` `control` `command` `win` `window` `meta` `shift` `alt`

## Equal key

    command = win = window = meta
    control = ctrl

## License

[MIT](LICENSE)