is-hotkey-combine
v1.0.1
Published
The shortest way to check multi-times keydown
Downloads
6
Maintainers
Readme
is-hotkey-combine
The shortest way to check multi-times keydown
Inspired by is-hotkey
Installation
npm install is-hotkey-combine
# or use yarn
yarn add is-hotkey-combine
Usage
import isHotkeyCombine from 'is-hotkey-combine'
document.addEventListener('keydown', evt => {
if (isHotkeyCombine('shift*2', evt /*, options */)) {
// trigger when pressing `shift` twice
}
if (isHotkeyCombine('shift+a->b', evt /*, options */)) {
// trigger when pressing `shift+a` and `b` quickly
}
if (isHotkeyCombine(['shift+a', 'b'], evt /*, options */)) {
// trigger when pressing `shift+a` and `b` quickly
}
})
API
isHotkeyCombine(hotKey: string|string[], event: Event, options): boolean
Options
duration
The duration about nearby trigger.
- Type:
number
- Default:
250
byKey
Extends from is-hotkey
Contributing
- Fork it!
- Create your new branch:
git checkout -b feature-new
orgit checkout -b fix-which-bug
- Start your magic work now
- Make sure npm test passes
- Commit your changes:
git commit -am 'feat: some description (close #123)'
orgit commit -am 'fix: some description (fix #123)'
- Push to the branch:
git push
- Submit a pull request :)
Authors
This library is written and maintained by imcuttle, [email protected].
License
MIT - imcuttle 🐟