Pass extraData to all events

Close mar10#114

Author: mar10

CHANGELOG.md

@@ -1,6 +1,8 @@
-# 1.15.1-0 / Unreleased
+# 1.16.0-0 / Unreleased
 
- * 
+  * [FEATURE] #114: Pass `extraData` argument to `select` and other events.  
+    The same ui.extraData instance is passed to all events of a open-select-close
+    sequence, so it can also be used to pass data between events.
 
 # 1.15.0 / 2017-03-18
 

README.md

@@ -86,7 +86,7 @@ $("#container").contextmenu({
 
 Alternatively we can
 <a href="https://github.com/mar10/jquery-ui-contextmenu/wiki#initialize-menu-from-an-existing-ul-element">
-initialaize the menu from embedded &lt;ul> markup</a>.
+initialize the menu from embedded &lt;ul> markup</a>.
 
 For more information:
 

jquery.ui-contextmenu.js

@@ -34,7 +34,7 @@ $.widget("moogle.contextmenu", {
 	version: "@VERSION",
 	options: {
 		addClass: "ui-contextmenu",  // Add this class to the outer <ul>
-		autoFocus: false,      // Set keyboard focus to first entry on open
+		autoFocus: false,     // Set keyboard focus to first entry on open
 		autoTrigger: true,    // open menu on browser's `contextmenu` event
 		delegate: null,       // selector
 		hide: { effect: "fadeOut", duration: "fast" },
@@ -66,6 +66,7 @@ $.widget("moogle.contextmenu", {
 		this.$menu = null;
 		this.menuIsTemp = false;
 		this.currentTarget = null;
+		this.extraData = {};
 		this.previousFocus = null;
 
 		if (opts.preventSelect) {
@@ -120,16 +121,18 @@ $.widget("moogle.contextmenu", {
 	},
 	/** (Re)Create jQuery UI Menu. */
 	_createUiMenu: function(menuDef) {
-		var ct,
+		var ct, ed,
 			opts = this.options;
 
 		// Remove temporary <ul> if any
 		if (this.isOpen()) {
 			// #58: 'replaceMenu' in beforeOpen causing select: to lose ui.target
 			ct = this.currentTarget;
+			ed = this.extraData;
 			// close without animation, to force async mode
 			this._closeMenu(true);
 			this.currentTarget = ct;
+			this.extraData = ed;
 		}
 		if (this.menuIsTemp) {
 			this.$menu.remove(); // this will also destroy ui.menu
@@ -171,6 +174,7 @@ $.widget("moogle.contextmenu", {
 
 					ui.cmd = ui.item.attr("data-command");
 					ui.target = $(this.currentTarget);
+					ui.extraData = this.extraData;
 					// ignore clicks, if they only open a sub-menu
 					if ( !isParent || !opts.ignoreParentSelect) {
 						retval = this._trigger.call(this, "select", event, ui);
@@ -187,24 +191,24 @@ $.widget("moogle.contextmenu", {
 	},
 	/** Open popup (called on 'contextmenu' event). */
 	_openMenu: function(event, recursive) {
-		var res, promise,
+		var res, promise, ui,
 			opts = this.options,
 			posOption = opts.position,
 			self = this,
-			manualTrigger = !!event.isTrigger,
-			ui = { menu: this.$menu, target: $(event.target),
-				   extraData: event._extraData, originalEvent: event,
-				   result: null };
+			manualTrigger = !!event.isTrigger;
 
 		if ( !opts.autoTrigger && !manualTrigger ) {
 			// ignore browser's `contextmenu` events
 			return;
 		}
-
 		// Prevent browser from opening the system context menu
 		event.preventDefault();
 
 		this.currentTarget = event.target;
+		this.extraData = event._extraData || {};
+
+		ui = { menu: this.$menu, target: $(this.currentTarget), extraData: this.extraData,
+			   originalEvent: event, result: null };
 
 		if ( !recursive ) {
 			res = this._trigger("beforeOpen", event, ui);
@@ -280,7 +284,7 @@ $.widget("moogle.contextmenu", {
 	_closeMenu: function(immediately) {
 		var self = this,
 			hideOpts = immediately ? false : this.options.hide,
-			ui = { menu: this.$menu, target: $(this.currentTarget) };
+			ui = { menu: this.$menu, target: $(this.currentTarget), extraData: this.extraData };
 
 		// Note: we don't want to unbind the 'contextmenu' event
 		$(document)
@@ -289,6 +293,7 @@ $.widget("moogle.contextmenu", {
 			.unbind("keydown" + this.eventNamespace);
 
 		self.currentTarget = null; // issue #44 after hide animation is too late
+		self.extraData = {};
 		if ( this.$menu ) { // #88: widget might have been destroyed already
 			this.$menu
 				.unbind("contextmenu" + this.eventNamespace);

test/tests.js

@@ -293,7 +293,7 @@ function _clickTest(menu, assert) {
 	var $ctx, $popup,
 		done = assert.async();
 
-	assert.expect(6);
+	assert.expect(13);
 
 	$("#container").contextmenu({
 		delegate: ".hasmenu",
@@ -303,6 +303,8 @@ function _clickTest(menu, assert) {
 		beforeOpen: function(event, ui) {
 			log("beforeOpen(" + ui.target.text() + ")");
 			assert.equal( ui.target.text(), "AAA", "beforeOpen: ui.target is set" );
+			assert.equal( ui.extraData.foo, "bar", "beforeOpen: ui.extraData is set" );
+			ui.extraData.helloFromBO = true;
 		},
 		create: function(event, ui) {
 			log("create");
@@ -330,18 +332,24 @@ function _clickTest(menu, assert) {
 			log("select(" + t + ")");
 			assert.equal( ui.cmd, "cut", "select: ui.cmd is set" );
 			assert.equal( ui.target.text(), "AAA", "select: ui.target is set" );
+			assert.equal( ui.extraData.foo, "bar", "select: ui.extraData is set" );
+			assert.equal( ui.extraData.helloFromBO, true, "select: ui.extraData is maintained" );
 		},
 		open: function(event, ui) {
 			log("open");
 			assert.equal( ui.target.text(), "AAA", "open: ui.target is set" );
+			assert.equal( ui.extraData.foo, "bar", "open: ui.extraData is set" );
+			assert.equal( ui.extraData.helloFromBO, true, "open: ui.extraData is maintained" );
 			setTimeout(function() {
 				entryEvent($popup, 0, "mouseenter");
 				click($popup, 0);
 			}, 10);
 		},
 		close: function(event, ui) {
 			log("close");
-			assert.equal( ui.target.text(), "AAA", "open: ui.target is set" );
+			assert.equal( ui.target.text(), "AAA", "close: ui.target is set" );
+			assert.equal( ui.extraData.foo, "bar", "close: ui.extraData is set" );
+			assert.equal( ui.extraData.helloFromBO, true, "close: ui.extraData is maintained" );
 			assert.equal(logOutput(),
 				  "createMenu,create,open(),beforeOpen(AAA),after open(),open,select(cut),close",
 				  "Event sequence OK.");
@@ -353,16 +361,8 @@ function _clickTest(menu, assert) {
 	$popup = $ctx.contextmenu("getMenu");
 
 	log("open()");
-	$ctx.contextmenu("open", $("span.hasmenu:first"));
+	$ctx.contextmenu("open", $("span.hasmenu:first"), { foo: "bar" });
 	log("after open()");
-
-	// setTimeout(function() {
-	// 	// TODO: why is focus() called twice?
-	// 	assert.equal(logOutput(),
-	// 		  "createMenu,create,open(),beforeOpen(AAA),after open(),open,select(cut),close",
-	// 		  "Event sequence OK.");
-	// 	done();
-	// }, 500);
 }
 
 QUnit.test("Array menu", function(assert) {
@@ -428,12 +428,6 @@ QUnit.test("Array menu", function(assert) {
    log("open()");
    $ctx.contextmenu("open", $("span.hasmenu:first"));
    log("after open()");
-
-   // setTimeout(function() {
-	  //  assert.equal(logOutput(), "open(),after open(),open,select(cut),cut action,close",
-		 //   "Event sequence OK.");
-	  //  done();
-   // }, 500);
 });
 
 // ****************************************************************************
@@ -506,13 +500,6 @@ QUnit.test("modify on open", function(assert) {
    log("open()");
    $ctx.contextmenu("open", $("span.hasmenu:first"));
    log("after open()");
-
-   // setTimeout(function() {
-	  //  assert.equal(logOutput(), "open(),beforeOpen,after open(),open,select(cut),close",
-		 //   "Event sequence OK.");
-	  //  done();
-   // }, 1500);
-
 });
 
 });