Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added support for on hover notifications #14

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions index.htm
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
<style type="text/css">form input { display:block; width:250px; margin-bottom:5px }</style>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1/jquery.js" type="text/javascript"></script>
<script src="http://ajax.googleapis.com/ajax/libs/jqueryui/1/jquery-ui.js" type="text/javascript"></script>
<script src="src/jquery.hoverIntent.js" type="text/javascript"></script>
<script src="src/jquery.notify.js" type="text/javascript"></script>

<script type="text/javascript">
Expand All @@ -32,6 +33,15 @@
create("default", { title:'Default Notification', text:'Example of a default notification. I will fade out after 5 seconds'});
});

$("#defaultHover").click(function(){
create("default", { title:'Default Notification', text:'Example of a default notification. I will fade out after 5 seconds or when mouse hover over it! Uses hoverIntent.js'}, {hover: function(e, instance) {instance.close()}});
});

$("#defaultHoverjQuery").click(function(){
create("default", { title:'Default Notification', text:'Example of a default notification. I will fade out after 5 seconds or when mouse hover over it! Does not uses hoverIntent.js'}, {useHoverIntent: false, hover: function(e, instance) {instance.close()}});
});


$("#sticky").click(function(){
create("sticky", { title:'Sticky Notification', text:'Example of a "sticky" notification. Click on the X above to close me.'},{ expires:false });
});
Expand Down Expand Up @@ -100,6 +110,8 @@ <h1>jQuery UI Notify Widget</h1>

<form style="margin:20px 0">
<input type="button" id="default" value="Open with default configuration" />
<input type="button" id="defaultHover" value="Open with default configuration. Will close on hover (hoverIntent.js)"/>
<input type="button" id="defaultHoverjQuery" value="Open with default configuration. Will close on hover (no hoverIntent.js)"/>
<input type="button" id="queue" value="Or with Queueing" />
<input type="button" id="sticky" value="Create a &quot;sticky&quot; notification" />
<input type="button" id="warning" value="Use icons in your templates" />
Expand Down
111 changes: 111 additions & 0 deletions src/jquery.hoverIntent.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
/**
* hoverIntent is similar to jQuery's built-in "hover" function except that
* instead of firing the onMouseOver event immediately, hoverIntent checks
* to see if the user's mouse has slowed down (beneath the sensitivity
* threshold) before firing the onMouseOver event.
*
* hoverIntent r5 // 2007.03.27 // jQuery 1.1.2+
* <http://cherne.net/brian/resources/jquery.hoverIntent.html>
*
* hoverIntent is currently available for use in all personal or commercial
* projects under both MIT and GPL licenses. This means that you can choose
* the license that best suits your project, and use it accordingly.
*
* // basic usage (just like .hover) receives onMouseOver and onMouseOut functions
* $("ul li").hoverIntent( showNav , hideNav );
*
* // advanced usage receives configuration object only
* $("ul li").hoverIntent({
* sensitivity: 7, // number = sensitivity threshold (must be 1 or higher)
* interval: 100, // number = milliseconds of polling interval
* over: showNav, // function = onMouseOver callback (required)
* timeout: 0, // number = milliseconds delay before onMouseOut function call
* out: hideNav // function = onMouseOut callback (required)
* });
*
* @param f onMouseOver function || An object with configuration options
* @param g onMouseOut function || Nothing (use configuration options object)
* @author Brian Cherne <[email protected]>
*/
(function($) {
$.fn.hoverIntent = function(f,g) {
// default configuration options
var cfg = {
sensitivity: 7,
interval: 100,
timeout: 0
};
// override configuration options with user supplied object
cfg = $.extend(cfg, g ? { over: f, out: g } : f );

// instantiate variables
// cX, cY = current X and Y position of mouse, updated by mousemove event
// pX, pY = previous X and Y position of mouse, set by mouseover and polling interval
var cX, cY, pX, pY;

// A private function for getting mouse position
var track = function(ev) {
cX = ev.pageX;
cY = ev.pageY;
};

// A private function for comparing current and previous mouse position
var compare = function(ev,ob) {
ob.hoverIntent_t = clearTimeout(ob.hoverIntent_t);
// compare mouse positions to see if they've crossed the threshold
if ( ( Math.abs(pX-cX) + Math.abs(pY-cY) ) < cfg.sensitivity ) {
$(ob).unbind("mousemove",track);
// set hoverIntent state to true (so mouseOut can be called)
ob.hoverIntent_s = 1;
return cfg.over.apply(ob,[ev]);
} else {
// set previous coordinates for next time
pX = cX; pY = cY;
// use self-calling timeout, guarantees intervals are spaced out properly (avoids JavaScript timer bugs)
ob.hoverIntent_t = setTimeout( function(){compare(ev, ob);} , cfg.interval );
}
};

// A private function for delaying the mouseOut function
var delay = function(ev,ob) {
ob.hoverIntent_t = clearTimeout(ob.hoverIntent_t);
ob.hoverIntent_s = 0;
return cfg.out.apply(ob,[ev]);
};

// A private function for handling mouse 'hovering'
var handleHover = function(e) {
// next three lines copied from jQuery.hover, ignore children onMouseOver/onMouseOut
var p = (e.type == "mouseover" ? e.fromElement : e.toElement) || e.relatedTarget;
while ( p && p != this ) { try { p = p.parentNode; } catch(e) { p = this; } }
if ( p == this ) { return false; }

// copy objects to be passed into t (required for event object to be passed in IE)
var ev = jQuery.extend({},e);
var ob = this;

// cancel hoverIntent timer if it exists
if (ob.hoverIntent_t) { ob.hoverIntent_t = clearTimeout(ob.hoverIntent_t); }

// else e.type == "onmouseover"
if (e.type == "mouseover") {
// set "previous" X and Y position based on initial entry point
pX = ev.pageX; pY = ev.pageY;
// update "current" X and Y position based on mousemove
$(ob).bind("mousemove",track);
// start polling interval (self-calling timeout) to compare mouse coordinates over time
if (ob.hoverIntent_s != 1) { ob.hoverIntent_t = setTimeout( function(){compare(ev,ob);} , cfg.interval );}

// else e.type == "onmouseout"
} else {
// unbind expensive mousemove event
$(ob).unbind("mousemove",track);
// if hoverIntent state is true, then call the mouseOut function after the specified delay
if (ob.hoverIntent_s == 1) { ob.hoverIntent_t = setTimeout( function(){delay(ev,ob);} , cfg.timeout );}
}
};

// bind the function to the two event listeners
return this.mouseover(handleHover).mouseout(handleHover);
};
})(jQuery);
57 changes: 55 additions & 2 deletions src/jquery.notify.js
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,56 @@
if(typeof this.options.click === "function"){
m.addClass("ui-notify-click").bind("click", function(e){
self._trigger("click", e, self);
});
});
}

if(typeof this.options.hover === "function"){
// hover intent present
if(typeof m.hoverIntent === "function") {
if(this.options.useHoverIntent != null && this.options.useHoverIntent == false) {
m.hover(
function (e) {
try {
self._trigger("hover", e, self);
} catch (e) {
}
},
function (e) {
if(typeof self.options.out === "function") {
self._trigger("out", e, self);
}
}
);
} else {
m.hoverIntent({
over: function(ob,e) {
try {
self._trigger("hover", e, self);
} catch (e) {
}
},
out: function(ob,e) {
if(typeof self.options.out === "function") {
self._trigger("out", e, self);
}
}
});
}
} else {
m.hover(
function (e) {
try {
self._trigger("hover", e, self);
} catch (e) {
}
},
function (e) {
if(typeof self.options.out === "function") {
self._trigger("out", e, self);
}
}
);
}
}

// show close link?
Expand Down Expand Up @@ -140,7 +189,11 @@
self._trigger("open");
self.isOpen = true;
});


if(this.options.afterOpenEffect != null) {
$(this.element).effect(this.options.afterOpenEffect, { times: this.options.afterOpenEffectRepeat }, this.options.afterOpenEffectSpeed);
}

return this;
},

Expand Down
2 changes: 1 addition & 1 deletion src/jquery.notify.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.