select event has new parameters ui.cmd and ui.target.

Closed mar10#23

Author: mar10

CHANGELOG.md

@@ -1,6 +1,7 @@
 # 0.5.0 / Unreleased
 
 * [CHANGE] Changed widget namespace from 'ui' to 'moogle'.
+* [FEATURE] `select` event has new parameters `ui.cmd` and `ui.target`.
 
 # 0.4.0 / 2013-05-28
 

README.md

@@ -17,6 +17,7 @@ Beta. Please report issues.
 
 Latest release is available for download at 
 [The jQuery Plugin Registry](http://plugins.jquery.com/ui-contextmenu/).
+See also the [Change Log](https://github.com/mar10/jquery-ui-contextmenu/blob/master/CHANGELOG.md).
 
 
 ## Demo
@@ -51,8 +52,7 @@ $("#container").contextmenu({
 			]}
 		],
 	select: function(event, ui) {
-		var menuId = ui.item.find(">a").attr("href");
-		alert("select " + menuId + " on " + $(event.relatedTarget).text());
+		alert("select " + ui.cmd + " on " + ui.target.text());
 	}
 });
 ```
@@ -207,29 +207,25 @@ jquery-contextmenu exposes events from [jQueryUI menu]: `blur`, `create`, `focus
 However, since the `event.target` parameter contains the menu item, we additionally pass the element 
 that was right-clicked in `event.relatedTarget`.
 
-Events may be handled by defining a handler option:
+Events may be handled by passing a handler callback option:
 ```js
 $("#container").contextmenu({
     [...]
     select: function(event, ui) {
-        var menuId = ui.item.find(">a").attr("href"),
-            target = event.relatedTarget;
-        alert("select " + menuId + " on " + $(target).text());
+        alert("select " + ui.cmd + " on " + ui.target.text());
     }
 });
 ```
 
 Alternatively a handler may be bound, so this is equivalent:
 ```js
 $("#container").bind("contextmenuselect", function(event, ui) {
-    var menuId = ui.item.find(">a").attr("href"),
-        target = event.relatedTarget;
-    alert("select " + menuId + " on " + $(target).text());
+    alert("select " + ui.cmd + " on " + ui.target.text());
 }
 ```
 
 <dl>
-<dt>beforeOpen(event)</dt>
+<dt>beforeOpen(event, ui)</dt>
 <dd>
     Triggered just before the popup menu is opened.<br>
     Return <code>false</code> to prevent opening.<br>
@@ -263,6 +259,7 @@ $("#container").bind("contextmenuselect", function(event, ui) {
 <dt>select(event, ui)</dt>
 <dd>
     Triggered when a menu item is selected.<br>
+    <code>ui.cmd</code> contains thecommand id.
     Return <code>false</code> to prevent closing the menu.
 </dd>
 </dl>
@@ -276,6 +273,6 @@ Contributors in order of appearance:
 
 ~~~~
 
-[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/mar10/jquery-contextmenu/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/mar10/jquery-contextmenu/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
 
 [jQueryUI menu]: http://jqueryui.com/menu/

demo/index.html

@@ -80,21 +80,20 @@
 				]}
 			],
 		select: function(event, ui) {
-			var menuId = ui.item.find(">a").attr("href"),
-				$target = $(event.relatedTarget);
-			switch(menuId){
-			case "#copy":
+			var $target = $(event.relatedTarget);
+			switch(ui.cmd){
+			case "copy":
 				CLIPBOARD = $target.text();
 				break
-			case "#paste":
+			case "paste":
 				CLIPBOARD = "";
 				break
 			}
-			alert("select " + menuId + " on " + $(event.relatedTarget).text());
+			alert("select " + ui.cmd + " on " + ui.target.text());
 		},
 		beforeOpen: function(event, ui) {
 			var $menu = ui.menu,
-				$target = $(event.relatedTarget);
+				$target = ui.target;
 //			console.log("beforeOpen", this, event, ui, "" + CLIPBOARD);
 			$(document)
 //				.contextmenu("replaceMenu", [{title: "aaa"}, {title: "bbb"}])
@@ -127,16 +126,15 @@
 		blur: function(event, ui) {
 			$("#info").text("");
 		},
-		beforeOpen: function(event) {
+		beforeOpen: function(event, ui) {
 //			$("#container").contextmenu("replaceMenu", [{title: "aaa"}, {title: "bbb"}]);
-//          alert("beforeopen on " + $(event.relatedTarget).text());
+//          alert("beforeopen on " + ui.target.text());
 		},
 		open: function(event, ui) {
-//          alert("open on " + $(event.relatedTarget).text());
+//          alert("open on " + ui.target.text());
 		},
 		select: function(event, ui) {
-			var menuId = ui.item.find(">a").attr("href");
-			alert("select " + menuId + " on " + $(event.relatedTarget).text());
+			alert("select " + ui.cmd + " on " + ui.target.text());
 		}
 	});
 

jquery.ui-contextmenu.js

@@ -89,6 +89,8 @@
 					select: $.proxy(function(event, ui){
 						// Also pass the target that the menu was triggered on:
 						event.relatedTarget = this.currentTarget;
+                        ui.cmd = normCommand(ui.item.find(">a").attr("href"));
+                        ui.target = $(this.currentTarget);
 						// ignore clicks, if they only open a sub-menu
 						var isParent = (ui.item.has(">a[aria-haspopup='true']").length > 0);
 						if( !isParent || !this.options.ignoreParentSelect){
@@ -130,7 +132,7 @@
 				openEvent = event,
 				// if called by 'open' method, 'relatedTarget' is the requested target object
 				parentTarget = openEvent.target ? openEvent.target : openEvent,
-				ui = {menu: $menu};
+				ui = {menu: $menu, target: $(openEvent.target)};
 			this.currentTarget = openEvent.target;
 			// Prevent browser from opening the system context menu
 			event.preventDefault();
@@ -175,7 +177,7 @@
 				}).position(posOption).hide();
 
 			this._show($menu, this.options.show, function(){
-				self._trigger.call(self, "open", event);
+				self._trigger.call(self, "open", event, ui);
 			});
 		},
 		/** Close popup. */