pass jshint and prepare 0.4.0

Author: mar10

CHANGELOG.md

@@ -1,4 +1,8 @@
-# 0.4.0 / Unreleased
+# 0.5.0 / Unreleased
+
+* 
+
+# 0.4.0 / 2013-05-28
 
 * [FEATURE] `position` option (thanks to Jeffrey Dean Altemus)
 

README.md

@@ -129,6 +129,19 @@ structure (see [jQueryUI menu] for details):
     If an array of objects is passed, it will be used to generate
     such markup on the fly.
 </dd>
+<dt>position</dt>
+<dd>
+    Type: <code>Object | Function</code>, default: <code>{my: "left top", at: "left bottom", of: parentTarget, collision: "fit"}</code><br>
+    Define position where popup opens. A simple <a href="http://api.jqueryui.com/position/">position</a> may be passed.<br>
+    Also a function may be specified, to recalculate position every time:<br>
+    <pre><code>
+    $("#container").contextmenu({
+//      position: {my: "left bottom", at: "right top"},
+        position: function(event, ui){
+            return {my: "left top", at: "center", of: event};
+        },
+    </code></pre>
+</dd>
 <dt>preventSelect</dt>
 <dd>
     Type: <code>Boolean</code>, default: <code>false</code><br>

demo/index.html

@@ -112,6 +112,10 @@
 	$("#container").contextmenu({
 		delegate: ".hasmenu2",
 		menu: "#options",
+//      position: {my: "left bottom", at: "right top"},
+		position: function(event, ui){
+			return {my: "left top", at: "center", of: event};
+		},
 		preventSelect: true,
 		taphold: true,
 		hide: { effect: "explode", duration: "slow" },
@@ -154,24 +158,29 @@ <h1>jquery.ui-contextmenu.js</h1>
 
 	<p><a href="https://github.com/mar10/jquery-ui-contextmenu">View project on GitHub</a></p>
 
-	Not-so-obvious features:
+	<h3>Sample 1</h3>
 	<ul>
+		<li>Initialized using a command-array.
+		<li>The menu is modified in the `beforeOpen` event (disabling an renaming entries).
 		<li>`preventSelect: true` prevents accidential selection of the menu
 			targets (i.e. 'AAA') when double-clicking or dragging the mouse.
 		<li>`taphold: true` enables long-press to open the menu (useful on
 			tablet computers).
 		<li>Ctrl+Click or two-finger-click on the touchpad also works (MacBook).
-		<li>The menu is modified in the `beforeOpen` event.
 	</ul>
-
-	<p>Right-click in an element to open the context menu (initialized by command-array):</p>
+	<p>Right-click in an element to open the context menu:</p>
 	<div>
 		<span class="hasmenu">AAA</span>
 		<span class="hasmenu">BBB</span>
 		<span class="hasmenu">CCC</span>
 	</div>
 
-	<p>Right-click in an element to open the context menu (initialized by hidden &lt;ul> element):</p>
+	<h3>Sample 2</h3>
+	<ul>
+		<li>Initialized by hidden &lt;ul> element.
+		<li>Use custom show/hide effects.
+		<li>Define custom position.
+	</ul>
 	<div id="container">
 		<span class="hasmenu2">AAA</span>
 		<span class="hasmenu2">BBB</span>
@@ -190,6 +199,7 @@ <h1>jquery.ui-contextmenu.js</h1>
 			</ul>
 	</ul>
 
+	<h3>Sample 3</h3>
 	<p>Open context menu using <code>$("#container").contextmenu("open", $(".hasmenu:first"))</code> and close after 2 sec.:</p>
 	<button id="triggerPopup">Trigger popup</button>
 </body>

jquery.ui-contextmenu.js

@@ -19,22 +19,23 @@
 	$.widget("ui.contextmenu", {
 		version: "0.4.0",
 		options: {
-			delegate: "[data-menu]",  // selector
+			delegate: "[data-menu]", // selector
 			hide: { effect: "fadeOut", duration: "fast"},
 			show: { effect: "slideDown", duration: "slow"},
+			position: null,       // specify positional preferences (added for issue #18 and #13).
 			ignoreParentSelect: true, // Don't trigger 'select' for sub-menu parents
 			menu: null,           // selector or jQuery or a function returning such
 			preventSelect: false, // disable text selection of target
-			taphold: false,       // open menu on taphold events (requires external plugins)
+			taphold: false,     // open menu on taphold events (requires external plugins)
 			// Events:
-			beforeOpen: $.noop,   // menu about to open; return `false` to prevent opening
-			blur: $.noop,         // menu option lost focus
-			close: $.noop,        // menu was closed
-			create: $.noop,       // menu was initialized
-			focus: $.noop,        // menu option got focus
-			init: $.noop,         // ui-contextmenu was initialized
-			open: $.noop,         // menu was opened
-			select: $.noop        // menu option was selected; return `false` to prevent closing
+			beforeOpen: $.noop, // menu about to open; return `false` to prevent opening
+			blur: $.noop,       // menu option lost focus
+			close: $.noop,      // menu was closed
+			create: $.noop,     // menu was initialized
+			focus: $.noop,      // menu option got focus
+			init: $.noop,       // ui-contextmenu was initialized
+			open: $.noop,       // menu was opened
+			select: $.noop      // menu option was selected; return `false` to prevent closing
 		},
 		/** Construtcor */
 		_create: function () {
@@ -122,7 +123,9 @@
 		},
 		/** Open popup (called on 'contextmenu' event). */
 		_openMenu: function(event){
-			var self = this,
+			var opts = this.options,
+				posOption = opts.position,
+				self = this,
 				$menu = this._getMenu(),
 				openEvent = event,
 				// if called by 'open' method, 'relatedTarget' is the requested target object
@@ -150,19 +153,26 @@
 					self._closeMenu();
 				}
 			});
+
+			// required for custom positioning (issue #18 and #13).
+			if ($.isFunction(posOption)) {
+				posOption = posOption(event, ui);
+			}
+			posOption = $.extend({
+				my: "left top",
+				at: "left bottom",
+				of: parentTarget,
+				collision: "fit"
+			}, posOption);
+
 			// Finally display the popup
 			$menu
 				.show() // required to fix positioning error (issue #3)
 				.css({
 					position: "absolute",
 					left: 0,
 					top: 0
-				}).position({
-					my: "left top",
-					at: "left bottom",
-					of: parentTarget,
-					collision: "fit"
-				}).hide();
+				}).position(posOption).hide();
 
 			this._show($menu, this.options.show, function(){
 				self._trigger.call(self, "open", event);
@@ -227,15 +237,15 @@
 					$menu.menu("refresh");
 				}else{
 					$.error("not implemented");
-//                    this.orgMenu = opts.menu;
-//                    opts.menu = $.ui.contextmenu.createMenuMarkup(data);
+//			this.orgMenu = opts.menu;
+//			opts.menu = $.ui.contextmenu.createMenuMarkup(data);
 				}
 			}else{
-//                if(this.orgMenu){
-//                    // re-use existing temporary <ul>
-//                }else{
-//                }
-//                $menu.menu("option", "menu", opts.menu);
+//		if(this.orgMenu){
+//			// re-use existing temporary <ul>
+//		}else{
+//		}
+//		$menu.menu("option", "menu", opts.menu);
 				$.error("not implemented");
 			}
 		},