241 lines
9.6 KiB
JavaScript
241 lines
9.6 KiB
JavaScript
|
/**
|
||
|
|
* jGrowl 1.2.0
|
||
|
|
*
|
||
|
|
* Dual licensed under the MIT (http://www.opensource.org/licenses/mit-license.php)
|
||
|
|
* and GPL (http://www.opensource.org/licenses/gpl-license.php) licenses.
|
||
|
|
*
|
||
|
|
* Written by Stan Lemon <stanlemon@mac.com>
|
||
|
|
* Last updated: 2009.05.11
|
||
|
|
*
|
||
|
|
* jGrowl is a jQuery plugin implementing unobtrusive userland notifications. These
|
||
|
|
* notifications function similarly to the Growl Framework available for
|
||
|
|
* Mac OS X (http://growl.info).
|
||
|
|
*
|
||
|
|
* To Do:
|
||
|
|
* - Move library settings to containers and allow them to be changed per container
|
||
|
|
*
|
||
|
|
* Changes in 1.2.0
|
||
|
|
* - Added message pooling to limit the number of messages appearing at a given time.
|
||
|
|
* - Closing a notification is now bound to the notification object and triggered by the close button.
|
||
|
|
*
|
||
|
|
* Changes in 1.1.2
|
||
|
|
* - Added iPhone styled example
|
||
|
|
* - Fixed possible IE7 bug when determining if the ie6 class shoudl be applied.
|
||
|
|
* - Added template for the close button, so that it's content could be customized.
|
||
|
|
*
|
||
|
|
* Changes in 1.1.1
|
||
|
|
* - Fixed CSS styling bug for ie6 caused by a mispelling
|
||
|
|
* - Changes height restriction on default notifications to min-height
|
||
|
|
* - Added skinned examples using a variety of images
|
||
|
|
* - Added the ability to customize the content of the [close all] box
|
||
|
|
* - Added jTweet, an example of using jGrowl + Twitter
|
||
|
|
*
|
||
|
|
* Changes in 1.1.0
|
||
|
|
* - Multiple container and instances.
|
||
|
|
* - Standard $.jGrowl() now wraps $.fn.jGrowl() by first establishing a generic jGrowl container.
|
||
|
|
* - Instance methods of a jGrowl container can be called by $.fn.jGrowl(methodName)
|
||
|
|
* - Added glue preferenced, which allows notifications to be inserted before or after nodes in the container
|
||
|
|
* - Added new log callback which is called before anything is done for the notification
|
||
|
|
* - Corner's attribute are now applied on an individual notification basis.
|
||
|
|
*
|
||
|
|
* Changes in 1.0.4
|
||
|
|
* - Various CSS fixes so that jGrowl renders correctly in IE6.
|
||
|
|
*
|
||
|
|
* Changes in 1.0.3
|
||
|
|
* - Fixed bug with options persisting across notifications
|
||
|
|
* - Fixed theme application bug
|
||
|
|
* - Simplified some selectors and manipulations.
|
||
|
|
* - Added beforeOpen and beforeClose callbacks
|
||
|
|
* - Reorganized some lines of code to be more readable
|
||
|
|
* - Removed unnecessary this.defaults context
|
||
|
|
* - If corners plugin is present, it's now customizable.
|
||
|
|
* - Customizable open animation.
|
||
|
|
* - Customizable close animation.
|
||
|
|
* - Customizable animation easing.
|
||
|
|
* - Added customizable positioning (top-left, top-right, bottom-left, bottom-right, center)
|
||
|
|
*
|
||
|
|
* Changes in 1.0.2
|
||
|
|
* - All CSS styling is now external.
|
||
|
|
* - Added a theme parameter which specifies a secondary class for styling, such
|
||
|
|
* that notifications can be customized in appearance on a per message basis.
|
||
|
|
* - Notification life span is now customizable on a per message basis.
|
||
|
|
* - Added the ability to disable the global closer, enabled by default.
|
||
|
|
* - Added callbacks for when a notification is opened or closed.
|
||
|
|
* - Added callback for the global closer.
|
||
|
|
* - Customizable animation speed.
|
||
|
|
* - jGrowl now set itself up and tears itself down.
|
||
|
|
*
|
||
|
|
* Changes in 1.0.1:
|
||
|
|
* - Removed dependency on metadata plugin in favor of .data()
|
||
|
|
* - Namespaced all events
|
||
|
|
*/
|
||
|
|
(function($) {
|
||
|
|
|
||
|
|
/** jGrowl Wrapper - Establish a base jGrowl Container for compatibility with older releases. **/
|
||
|
|
$.jGrowl = function( m , o ) {
|
||
|
|
// To maintain compatibility with older version that only supported one instance we'll create the base container.
|
||
|
|
if ( $('#jGrowl').size() == 0 ) $('<div id="jGrowl"></div>').addClass($.jGrowl.defaults.position).appendTo('body');
|
||
|
|
// Create a notification on the container.
|
||
|
|
$('#jGrowl').jGrowl(m,o);
|
||
|
|
};
|
||
|
|
|
||
|
|
|
||
|
|
/** Raise jGrowl Notification on a jGrowl Container **/
|
||
|
|
$.fn.jGrowl = function( m , o ) {
|
||
|
|
if ( $.isFunction(this.each) ) {
|
||
|
|
var args = arguments;
|
||
|
|
|
||
|
|
return this.each(function() {
|
||
|
|
var self = this;
|
||
|
|
|
||
|
|
/** Create a jGrowl Instance on the Container if it does not exist **/
|
||
|
|
if ( $(this).data('jGrowl.instance') == undefined ) {
|
||
|
|
$(this).data('jGrowl.instance', new $.fn.jGrowl());
|
||
|
|
$(this).data('jGrowl.instance').startup( this );
|
||
|
|
}
|
||
|
|
|
||
|
|
/** Optionally call jGrowl instance methods, or just raise a normal notification **/
|
||
|
|
if ( $.isFunction($(this).data('jGrowl.instance')[m]) ) {
|
||
|
|
$(this).data('jGrowl.instance')[m].apply( $(this).data('jGrowl.instance') , $.makeArray(args).slice(1) );
|
||
|
|
} else {
|
||
|
|
$(this).data('jGrowl.instance').create( m , o );
|
||
|
|
}
|
||
|
|
});
|
||
|
|
};
|
||
|
|
};
|
||
|
|
|
||
|
|
$.extend( $.fn.jGrowl.prototype , {
|
||
|
|
|
||
|
|
/** Default JGrowl Settings **/
|
||
|
|
defaults: {
|
||
|
|
pool: 0,
|
||
|
|
header: '',
|
||
|
|
group: '',
|
||
|
|
sticky: false,
|
||
|
|
position: 'top-right', // Is this still needed?
|
||
|
|
glue: 'after',
|
||
|
|
theme: 'default',
|
||
|
|
corners: '10px',
|
||
|
|
check: 250,
|
||
|
|
life: 3000,
|
||
|
|
speed: 'normal',
|
||
|
|
easing: 'swing',
|
||
|
|
closer: true,
|
||
|
|
closeTemplate: '×',
|
||
|
|
closerTemplate: '<div>[ close all ]</div>',
|
||
|
|
log: function(e,m,o) {},
|
||
|
|
beforeOpen: function(e,m,o) {},
|
||
|
|
open: function(e,m,o) {},
|
||
|
|
beforeClose: function(e,m,o) {},
|
||
|
|
close: function(e,m,o) {},
|
||
|
|
animateOpen: {
|
||
|
|
opacity: 'show'
|
||
|
|
},
|
||
|
|
animateClose: {
|
||
|
|
opacity: 'hide'
|
||
|
|
}
|
||
|
|
},
|
||
|
|
|
||
|
|
notifications: [],
|
||
|
|
|
||
|
|
/** jGrowl Container Node **/
|
||
|
|
element: null,
|
||
|
|
|
||
|
|
/** Interval Function **/
|
||
|
|
interval: null,
|
||
|
|
|
||
|
|
/** Create a Notification **/
|
||
|
|
create: function( message , o ) {
|
||
|
|
var o = $.extend({}, this.defaults, o);
|
||
|
|
|
||
|
|
this.notifications[ this.notifications.length ] = { message: message , options: o };
|
||
|
|
|
||
|
|
o.log.apply( this.element , [this.element,message,o] );
|
||
|
|
},
|
||
|
|
|
||
|
|
render: function( notification ) {
|
||
|
|
var self = this;
|
||
|
|
var message = notification.message;
|
||
|
|
var o = notification.options;
|
||
|
|
|
||
|
|
var notification = $('<div class="jGrowl-notification' + ((o.group != undefined && o.group != '') ? ' ' + o.group : '') + '"><div class="close">' + o.closeTemplate + '</div><div class="header">' + o.header + '</div><div class="message">' + message + '</div></div>')
|
||
|
|
.data("jGrowl", o).addClass(o.theme).children('div.close').bind("click.jGrowl", function() {
|
||
|
|
$(this).parent().trigger('jGrowl.close');
|
||
|
|
}).parent();
|
||
|
|
|
||
|
|
( o.glue == 'after' ) ? $('div.jGrowl-notification:last', this.element).after(notification) : $('div.jGrowl-notification:first', this.element).before(notification);
|
||
|
|
|
||
|
|
/** Notification Actions **/
|
||
|
|
$(notification).bind("mouseover.jGrowl", function() {
|
||
|
|
$(this).data("jGrowl").pause = true;
|
||
|
|
}).bind("mouseout.jGrowl", function() {
|
||
|
|
$(this).data("jGrowl").pause = false;
|
||
|
|
}).bind('jGrowl.beforeOpen', function() {
|
||
|
|
o.beforeOpen.apply( self.element , [self.element,message,o] );
|
||
|
|
}).bind('jGrowl.open', function() {
|
||
|
|
o.open.apply( self.element , [self.element,message,o] );
|
||
|
|
}).bind('jGrowl.beforeClose', function() {
|
||
|
|
o.beforeClose.apply( self.element , [self.element,message,o] );
|
||
|
|
}).bind('jGrowl.close', function() {
|
||
|
|
$(this).trigger('jGrowl.beforeClose').animate(o.animateClose, o.speed, o.easing, function() {
|
||
|
|
$(this).remove();
|
||
|
|
o.close.apply( self.element , [self.element,message,o] );
|
||
|
|
});
|
||
|
|
}).trigger('jGrowl.beforeOpen').animate(o.animateOpen, o.speed, o.easing, function() {
|
||
|
|
$(this).data("jGrowl").created = new Date();
|
||
|
|
}).trigger('jGrowl.open');
|
||
|
|
|
||
|
|
/** Optional Corners Plugin **/
|
||
|
|
if ( $.fn.corner != undefined ) $(notification).corner( o.corners );
|
||
|
|
|
||
|
|
/** Add a Global Closer if more than one notification exists **/
|
||
|
|
if ( $('div.jGrowl-notification:parent', this.element).size() > 1 && $('div.jGrowl-closer', this.element).size() == 0 && this.defaults.closer != false ) {
|
||
|
|
$(this.defaults.closerTemplate).addClass('jGrowl-closer').addClass(this.defaults.theme).appendTo(this.element).animate(this.defaults.animateOpen, this.defaults.speed, this.defaults.easing).bind("click.jGrowl", function() {
|
||
|
|
$(this).siblings().children('div.close').trigger("click.jGrowl");
|
||
|
|
|
||
|
|
if ( $.isFunction( self.defaults.closer ) ) self.defaults.closer.apply( $(this).parent()[0] , [$(this).parent()[0]] );
|
||
|
|
});
|
||
|
|
};
|
||
|
|
},
|
||
|
|
|
||
|
|
/** Update the jGrowl Container, removing old jGrowl notifications **/
|
||
|
|
update: function() {
|
||
|
|
$(this.element).find('div.jGrowl-notification:parent').each( function() {
|
||
|
|
if ( $(this).data("jGrowl") != undefined && $(this).data("jGrowl").created != undefined && ($(this).data("jGrowl").created.getTime() + $(this).data("jGrowl").life) < (new Date()).getTime() && $(this).data("jGrowl").sticky != true &&
|
||
|
|
($(this).data("jGrowl").pause == undefined || $(this).data("jGrowl").pause != true) ) {
|
||
|
|
$(this).trigger('jGrowl.close');
|
||
|
|
}
|
||
|
|
});
|
||
|
|
|
||
|
|
if ( this.notifications.length > 0 && (this.defaults.pool == 0 || $(this.element).find('div.jGrowl-notification:parent').size() < this.defaults.pool) ) {
|
||
|
|
this.render( this.notifications.shift() );
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( $(this.element).find('div.jGrowl-notification:parent').size() < 2 ) {
|
||
|
|
$(this.element).find('div.jGrowl-closer').animate(this.defaults.animateClose, this.defaults.speed, this.defaults.easing, function() {
|
||
|
|
$(this).remove();
|
||
|
|
});
|
||
|
|
};
|
||
|
|
},
|
||
|
|
|
||
|
|
/** Setup the jGrowl Notification Container **/
|
||
|
|
startup: function(e) {
|
||
|
|
this.element = $(e).addClass('jGrowl').append('<div class="jGrowl-notification"></div>');
|
||
|
|
this.interval = setInterval( function() {
|
||
|
|
jQuery(e).data('jGrowl.instance').update();
|
||
|
|
}, this.defaults.check);
|
||
|
|
|
||
|
|
if ($.browser.msie && parseInt($.browser.version) < 7 && !window["XMLHttpRequest"]) $(this.element).addClass('ie6');
|
||
|
|
},
|
||
|
|
|
||
|
|
/** Shutdown jGrowl, removing it and clearing the interval **/
|
||
|
|
shutdown: function() {
|
||
|
|
$(this.element).removeClass('jGrowl').find('div.jGrowl-notification').remove();
|
||
|
|
clearInterval( this.interval );
|
||
|
|
}
|
||
|
|
});
|
||
|
|
|
||
|
|
/** Reference the Defaults Object for compatibility with older versions of jGrowl **/
|
||
|
|
$.jGrowl.defaults = $.fn.jGrowl.prototype.defaults;
|
||
|
|
|
||
|
|
})(jQuery);
|