feat: add trigger method (#354).

README-zh.md

@@ -238,6 +238,13 @@ hotkeys.getScope();
 hotkeys.setScope('scope1');
 ```
 
+## trigger
+
+```js
+hotkeys.trigger('ctrl+o')
+hotkeys.trigger('ctrl+o', 'scope2')
+```
+
 ## 解除绑定
 
 `hotkeys.unbind()` 解除绑定的所有快捷键

README.md

@@ -176,6 +176,22 @@ hotkeys('+', { splitKey: '-' }, function(e){
 })
 ```
 
+**keyup**
+
+**key down** and **key up** both perform callback events.
+
+```js
+hotkeys('ctrl+a,alt+a+s', {keyup: true}, function(event, handler) {
+  if (event.type === 'keydown') {
+    console.log('keydown:', event.type, handler, handler.key);
+  }
+
+  if (event.type === 'keyup') {
+    console.log('keyup:', event.type, handler, handler.key);
+  }
+});
+```
+
 ## API REFERENCE
 
 Asterisk "*"
@@ -291,20 +307,11 @@ hotkeys('a', function() {
 });
 ```
 
-## keyup
-
-**key down** and **key up** both perform callback events.
+### trigger
 
 ```js
-hotkeys('ctrl+a,alt+a+s', {keyup: true}, function(event, handler) {
-  if (event.type === 'keydown') {
-    console.log('keydown:', event.type, handler, handler.key);
-  }
-
-  if (event.type === 'keyup') {
-    console.log('keyup:', event.type, handler, handler.key);
-  }
-});
+hotkeys.trigger('ctrl+o');
+hotkeys.trigger('ctrl+o', 'scope2');
 ```
 
 ### getPressedKeyCodes

dist/hotkeys.common.js

@@ -547,13 +547,27 @@ function hotkeys(key, option, method) {
   }
 }
 
+function trigger(shortcut) {
+  var scope = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'all';
+  Object.keys(_handlers).forEach(function (key) {
+    var data = _handlers[key].find(function (item) {
+      return item.scope === scope && item.shortcut === shortcut;
+    });
+
+    if (data && data.method) {
+      data.method();
+    }
+  });
+}
+
 var _api = {
   setScope: setScope,
   getScope: getScope,
   deleteScope: deleteScope,
   getPressedKeyCodes: getPressedKeyCodes,
   isPressed: isPressed,
   filter: filter,
+  trigger: trigger,
   unbind: unbind
 };
 

dist/hotkeys.esm.js

@@ -545,13 +545,27 @@ function hotkeys(key, option, method) {
   }
 }
 
+function trigger(shortcut) {
+  var scope = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'all';
+  Object.keys(_handlers).forEach(function (key) {
+    var data = _handlers[key].find(function (item) {
+      return item.scope === scope && item.shortcut === shortcut;
+    });
+
+    if (data && data.method) {
+      data.method();
+    }
+  });
+}
+
 var _api = {
   setScope: setScope,
   getScope: getScope,
   deleteScope: deleteScope,
   getPressedKeyCodes: getPressedKeyCodes,
   isPressed: isPressed,
   filter: filter,
+  trigger: trigger,
   unbind: unbind
 };
 

dist/hotkeys.js

@@ -551,13 +551,27 @@
     }
   }
 
+  function trigger(shortcut) {
+    var scope = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'all';
+    Object.keys(_handlers).forEach(function (key) {
+      var data = _handlers[key].find(function (item) {
+        return item.scope === scope && item.shortcut === shortcut;
+      });
+
+      if (data && data.method) {
+        data.method();
+      }
+    });
+  }
+
   var _api = {
     setScope: setScope,
     getScope: getScope,
     deleteScope: deleteScope,
     getPressedKeyCodes: getPressedKeyCodes,
     isPressed: isPressed,
     filter: filter,
+    trigger: trigger,
     unbind: unbind
   };
 

src/index.js

@@ -386,13 +386,23 @@ function hotkeys(key, option, method) {
   }
 }
 
+function trigger(shortcut, scope = 'all') {
+  Object.keys(_handlers).forEach((key) => {
+    const data = _handlers[key].find((item) => item.scope === scope && item.shortcut === shortcut);
+    if (data && data.method) {
+      data.method();
+    }
+  });
+}
+
 const _api = {
   setScope,
   getScope,
   deleteScope,
   getPressedKeyCodes,
   isPressed,
   filter,
+  trigger,
   unbind,
 };
 for (const a in _api) {