@peter.naydenov/shortcuts 1.0.0 → 1.1.0

package/Changelog.md

@@ -1,5 +1,11 @@
 ## Release History
 
+### 1.1.0 (2023-09-30)
+- [x] Method `emit` was added. Not documented yet;
+
+### 1.0.1 (2023-09-23)
+- [x] Mouse click: preventDefault();
+- [x] Dependencies update: @peter.naydenov/notice - v.2.2.1
 
 
 ### 1.0.0 (2023-08-14)

package/README.md

@@ -3,7 +3,15 @@
 ![version](https://img.shields.io/github/package-json/v/peterNaydenov/shortcuts)
 ![license](https://img.shields.io/github/license/peterNaydenov/shortcuts)
 
-Build a keyboard shortcuts maps and describe a mouse clicks. Control them on context.
+
+
+Define a context based keyboard-shortcuts and describe a mouse clicks. Switch among contexts.
+
+
+
+
+## What's new?
+Version 1.1.0 is coming with new method `emit` that make possible to trigger context functions also programmatically. In `shortcuts` you can mix keyboard, mouse and programmatical events that is prity everything that can happen in a web page.
 
 
 
@@ -11,6 +19,10 @@ Build a keyboard shortcuts maps and describe a mouse clicks. Control them on con
 The shortcuts definition includes a context name and a set of rules(object). The rules are a set of key-value pairs. The key is a shortcut name and the value is a function or array of functions, to be executed when the shortcut is triggered (action function).
 
 ```js
+// { context: { shortcutName: actionFunction } }
+// or
+// { context: { shortcutName: [ actionFunction1, actionFunction2 ] }}
+```
 // Shortcut definition object:
 {
     contextName : {
@@ -229,6 +241,7 @@ Description of the methods of shortcut instance:
   load          : 'Load and extend a shortcut definition.'
 , unload        : 'Remove a shortcut context with all its shortcuts.'
 , changeContext : 'Switch to existing shortcut context.'
+, emit          : 'Trigger a shortcut or custom event programmatically.'
 , pause         : 'Stop listening for shortcuts.'
 , resume        : 'Resume listening for shortcuts.'
 , listContexts  : 'Return list of available contexts.'

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@peter.naydenov/shortcuts",
-  "version": "1.0.0",
-  "description": "Create shortcuts for your web application based on keyboard and mouse events",
+  "version": "1.1.0",
+  "description": "Context control of shortcuts based on keyboard and mouse events",
   "keywords": [
     "shortcut",
     "key",
@@ -16,13 +16,17 @@
     "build": "vite build",
     "test": "cypress open --component --browser chrome test"
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/PeterNaydenov/shortcuts"
+  },
   "dependencies": {
-    "@peter.naydenov/notice": "^2.1.0"
+    "@peter.naydenov/notice": "^2.2.1"
   },
   "devDependencies": {
-    "@vitejs/plugin-react": "^4.0.4",
-    "chai": "^4.3.7",
-    "cypress": "^12.17.3",
+    "@vitejs/plugin-react": "^4.1.0",
+    "chai": "^4.3.10",
+    "cypress": "^13.3.0",
     "mocha": "^10.2.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",

package/src/changeContext.js

@@ -1,9 +1,5 @@
 'use strict'
 
-import listen from "./listen";
-
-
-
 function changeContext ( shortcuts, listenOptions, ev, currentContext ) {
 return function changeContext ( contextName = false ) {
         const current = currentContext.name;

package/src/listen.js

@@ -93,6 +93,7 @@ function listen ( dependencies, options, currentContext ) {   // Listen for inpu
 
     function listenMouse () {
                         window.addEventListener ( 'contextmenu', event => {   // Listen for right mouse clicks
+                                        event.preventDefault ()
                                         clearTimeout ( mouseTimer )
                                         if ( mouseIgnore ) {
                                                     clearTimeout ( mouseIgnore )
@@ -104,7 +105,6 @@ function listen ( dependencies, options, currentContext ) {   // Listen for inpu
                                                     mouseIgnore = setTimeout ( () => mouseIgnore=null, mouseWait )
                                                     return
                                             }
-                                        event.preventDefault ()
                                         mouseTarget = findTarget (event.target, clickTarget )
                                         mouseDomEvent = event
                                         count++
@@ -112,6 +112,7 @@ function listen ( dependencies, options, currentContext ) {   // Listen for inpu
                                 })
 
                         document.addEventListener ( 'click', event => {  // Listen for left and middle mouse clicks
+                                        event.preventDefault ()
                                         clearTimeout ( mouseTimer )
                                         if ( mouseIgnore ) {
                                                     clearTimeout ( mouseIgnore )

package/src/main.js

@@ -9,6 +9,7 @@
  *  History notes:
  *  - Development was started on June 21st, 2023
  *  - First version was published on August 14th, 2023
+ *  - Method 'emit' was added on September 30st, 2023
  */
 
 
@@ -67,6 +68,7 @@ function main ( options = {} ) {
       , changeContext : changeContext ( shortcuts, listenOptions, ev, currentContext )
       , pause         : () => ev.stop ()
       , resume        : () => ev.start ()
+      , emit          : (x,...args) => ev.emit ( readShortcut(x), ...args )
       , listContexts  : () => Object.keys ( shortcuts )
       , getContext
       , getNote 

package/test/01-general.cy.js

@@ -26,6 +26,8 @@ beforeEach ( () => {
     a = false, b = false
 }) // beforeEach
 
+
+
 it ( 'Simple shortcut', done => {
             let res = false;
             short.changeContext ( 'general' )
@@ -108,4 +110,19 @@ it ( 'Double mouse click', done => {
         })
 }) // it double mouse click
 
+
+
+it ( 'Emit custom event', () => {
+      let result = null;
+      const myAllContext = { 
+                              myAll: {
+                                        'mouse-click-leff-1' : () =>  console.log ( 'nothing' )
+                                      , 'yo' : r => result = r
+                                  }}
+      short.load ( myAllContext )
+      short.changeContext ( 'myAll' )
+      short.emit ( 'yo', 'hello' )
+      expect ( result ).to.be.equal ( 'hello' )
+}) // it emit custom event
+
 }) // describe