486 lines
14 KiB
JavaScript
Executable file
486 lines
14 KiB
JavaScript
Executable file
/*!
|
|
* # Semantic UI 2.1.7 - Nag
|
|
* http://github.com/semantic-org/semantic-ui/
|
|
*
|
|
*
|
|
* Copyright 2015 Contributors
|
|
* Released under the MIT license
|
|
* http://opensource.org/licenses/MIT
|
|
*
|
|
*/
|
|
|
|
;(function ($, window, document, undefined) {
|
|
|
|
"use strict";
|
|
|
|
$.fn.nag = function(parameters) {
|
|
var
|
|
$allModules = $(this),
|
|
moduleSelector = $allModules.selector || '',
|
|
|
|
time = new Date().getTime(),
|
|
performance = [],
|
|
|
|
query = arguments[0],
|
|
methodInvoked = (typeof query == 'string'),
|
|
queryArguments = [].slice.call(arguments, 1),
|
|
returnedValue
|
|
;
|
|
$allModules
|
|
.each(function() {
|
|
var
|
|
settings = ( $.isPlainObject(parameters) )
|
|
? $.extend(true, {}, $.fn.nag.settings, parameters)
|
|
: $.extend({}, $.fn.nag.settings),
|
|
|
|
className = settings.className,
|
|
selector = settings.selector,
|
|
error = settings.error,
|
|
namespace = settings.namespace,
|
|
|
|
eventNamespace = '.' + namespace,
|
|
moduleNamespace = namespace + '-module',
|
|
|
|
$module = $(this),
|
|
|
|
$close = $module.find(selector.close),
|
|
$context = (settings.context)
|
|
? $(settings.context)
|
|
: $('body'),
|
|
|
|
element = this,
|
|
instance = $module.data(moduleNamespace),
|
|
|
|
moduleOffset,
|
|
moduleHeight,
|
|
|
|
contextWidth,
|
|
contextHeight,
|
|
contextOffset,
|
|
|
|
yOffset,
|
|
yPosition,
|
|
|
|
timer,
|
|
module,
|
|
|
|
requestAnimationFrame = window.requestAnimationFrame
|
|
|| window.mozRequestAnimationFrame
|
|
|| window.webkitRequestAnimationFrame
|
|
|| window.msRequestAnimationFrame
|
|
|| function(callback) { setTimeout(callback, 0); }
|
|
;
|
|
module = {
|
|
|
|
initialize: function() {
|
|
module.verbose('Initializing element');
|
|
|
|
$module
|
|
.on('click' + eventNamespace, selector.close, module.dismiss)
|
|
.data(moduleNamespace, module)
|
|
;
|
|
|
|
if(settings.detachable && $module.parent()[0] !== $context[0]) {
|
|
$module
|
|
.detach()
|
|
.prependTo($context)
|
|
;
|
|
}
|
|
|
|
if(settings.displayTime > 0) {
|
|
setTimeout(module.hide, settings.displayTime);
|
|
}
|
|
module.show();
|
|
},
|
|
|
|
destroy: function() {
|
|
module.verbose('Destroying instance');
|
|
$module
|
|
.removeData(moduleNamespace)
|
|
.off(eventNamespace)
|
|
;
|
|
},
|
|
|
|
show: function() {
|
|
if( module.should.show() && !$module.is(':visible') ) {
|
|
module.debug('Showing nag', settings.animation.show);
|
|
if(settings.animation.show == 'fade') {
|
|
$module
|
|
.fadeIn(settings.duration, settings.easing)
|
|
;
|
|
}
|
|
else {
|
|
$module
|
|
.slideDown(settings.duration, settings.easing)
|
|
;
|
|
}
|
|
}
|
|
},
|
|
|
|
hide: function() {
|
|
module.debug('Showing nag', settings.animation.hide);
|
|
if(settings.animation.show == 'fade') {
|
|
$module
|
|
.fadeIn(settings.duration, settings.easing)
|
|
;
|
|
}
|
|
else {
|
|
$module
|
|
.slideUp(settings.duration, settings.easing)
|
|
;
|
|
}
|
|
},
|
|
|
|
onHide: function() {
|
|
module.debug('Removing nag', settings.animation.hide);
|
|
$module.remove();
|
|
if (settings.onHide) {
|
|
settings.onHide();
|
|
}
|
|
},
|
|
|
|
dismiss: function(event) {
|
|
if(settings.storageMethod) {
|
|
module.storage.set(settings.key, settings.value);
|
|
}
|
|
module.hide();
|
|
event.stopImmediatePropagation();
|
|
event.preventDefault();
|
|
},
|
|
|
|
should: {
|
|
show: function() {
|
|
if(settings.persist) {
|
|
module.debug('Persistent nag is set, can show nag');
|
|
return true;
|
|
}
|
|
if( module.storage.get(settings.key) != settings.value.toString() ) {
|
|
module.debug('Stored value is not set, can show nag', module.storage.get(settings.key));
|
|
return true;
|
|
}
|
|
module.debug('Stored value is set, cannot show nag', module.storage.get(settings.key));
|
|
return false;
|
|
}
|
|
},
|
|
|
|
get: {
|
|
storageOptions: function() {
|
|
var
|
|
options = {}
|
|
;
|
|
if(settings.expires) {
|
|
options.expires = settings.expires;
|
|
}
|
|
if(settings.domain) {
|
|
options.domain = settings.domain;
|
|
}
|
|
if(settings.path) {
|
|
options.path = settings.path;
|
|
}
|
|
return options;
|
|
}
|
|
},
|
|
|
|
clear: function() {
|
|
module.storage.remove(settings.key);
|
|
},
|
|
|
|
storage: {
|
|
set: function(key, value) {
|
|
var
|
|
options = module.get.storageOptions()
|
|
;
|
|
if(settings.storageMethod == 'localstorage' && window.localStorage !== undefined) {
|
|
window.localStorage.setItem(key, value);
|
|
module.debug('Value stored using local storage', key, value);
|
|
}
|
|
else if(settings.storageMethod == 'sessionstorage' && window.sessionStorage !== undefined) {
|
|
window.sessionStorage.setItem(key, value);
|
|
module.debug('Value stored using session storage', key, value);
|
|
}
|
|
else if($.cookie !== undefined) {
|
|
$.cookie(key, value, options);
|
|
module.debug('Value stored using cookie', key, value, options);
|
|
}
|
|
else {
|
|
module.error(error.noCookieStorage);
|
|
return;
|
|
}
|
|
},
|
|
get: function(key, value) {
|
|
var
|
|
storedValue
|
|
;
|
|
if(settings.storageMethod == 'localstorage' && window.localStorage !== undefined) {
|
|
storedValue = window.localStorage.getItem(key);
|
|
}
|
|
else if(settings.storageMethod == 'sessionstorage' && window.sessionStorage !== undefined) {
|
|
storedValue = window.sessionStorage.getItem(key);
|
|
}
|
|
// get by cookie
|
|
else if($.cookie !== undefined) {
|
|
storedValue = $.cookie(key);
|
|
}
|
|
else {
|
|
module.error(error.noCookieStorage);
|
|
}
|
|
if(storedValue == 'undefined' || storedValue == 'null' || storedValue === undefined || storedValue === null) {
|
|
storedValue = undefined;
|
|
}
|
|
return storedValue;
|
|
},
|
|
remove: function(key) {
|
|
var
|
|
options = module.get.storageOptions()
|
|
;
|
|
if(settings.storageMethod == 'localstorage' && window.localStorage !== undefined) {
|
|
window.localStorage.removeItem(key);
|
|
}
|
|
else if(settings.storageMethod == 'sessionstorage' && window.sessionStorage !== undefined) {
|
|
window.sessionStorage.removeItem(key);
|
|
}
|
|
// store by cookie
|
|
else if($.cookie !== undefined) {
|
|
$.removeCookie(key, options);
|
|
}
|
|
else {
|
|
module.error(error.noStorage);
|
|
}
|
|
}
|
|
},
|
|
|
|
setting: function(name, value) {
|
|
module.debug('Changing setting', name, value);
|
|
if( $.isPlainObject(name) ) {
|
|
$.extend(true, settings, name);
|
|
}
|
|
else if(value !== undefined) {
|
|
settings[name] = value;
|
|
}
|
|
else {
|
|
return settings[name];
|
|
}
|
|
},
|
|
internal: function(name, value) {
|
|
if( $.isPlainObject(name) ) {
|
|
$.extend(true, module, name);
|
|
}
|
|
else if(value !== undefined) {
|
|
module[name] = value;
|
|
}
|
|
else {
|
|
return module[name];
|
|
}
|
|
},
|
|
debug: function() {
|
|
if(settings.debug) {
|
|
if(settings.performance) {
|
|
module.performance.log(arguments);
|
|
}
|
|
else {
|
|
module.debug = Function.prototype.bind.call(console.info, console, settings.name + ':');
|
|
module.debug.apply(console, arguments);
|
|
}
|
|
}
|
|
},
|
|
verbose: function() {
|
|
if(settings.verbose && settings.debug) {
|
|
if(settings.performance) {
|
|
module.performance.log(arguments);
|
|
}
|
|
else {
|
|
module.verbose = Function.prototype.bind.call(console.info, console, settings.name + ':');
|
|
module.verbose.apply(console, arguments);
|
|
}
|
|
}
|
|
},
|
|
error: function() {
|
|
module.error = Function.prototype.bind.call(console.error, console, settings.name + ':');
|
|
module.error.apply(console, arguments);
|
|
},
|
|
performance: {
|
|
log: function(message) {
|
|
var
|
|
currentTime,
|
|
executionTime,
|
|
previousTime
|
|
;
|
|
if(settings.performance) {
|
|
currentTime = new Date().getTime();
|
|
previousTime = time || currentTime;
|
|
executionTime = currentTime - previousTime;
|
|
time = currentTime;
|
|
performance.push({
|
|
'Name' : message[0],
|
|
'Arguments' : [].slice.call(message, 1) || '',
|
|
'Element' : element,
|
|
'Execution Time' : executionTime
|
|
});
|
|
}
|
|
clearTimeout(module.performance.timer);
|
|
module.performance.timer = setTimeout(module.performance.display, 500);
|
|
},
|
|
display: function() {
|
|
var
|
|
title = settings.name + ':',
|
|
totalTime = 0
|
|
;
|
|
time = false;
|
|
clearTimeout(module.performance.timer);
|
|
$.each(performance, function(index, data) {
|
|
totalTime += data['Execution Time'];
|
|
});
|
|
title += ' ' + totalTime + 'ms';
|
|
if(moduleSelector) {
|
|
title += ' \'' + moduleSelector + '\'';
|
|
}
|
|
if( (console.group !== undefined || console.table !== undefined) && performance.length > 0) {
|
|
console.groupCollapsed(title);
|
|
if(console.table) {
|
|
console.table(performance);
|
|
}
|
|
else {
|
|
$.each(performance, function(index, data) {
|
|
console.log(data['Name'] + ': ' + data['Execution Time']+'ms');
|
|
});
|
|
}
|
|
console.groupEnd();
|
|
}
|
|
performance = [];
|
|
}
|
|
},
|
|
invoke: function(query, passedArguments, context) {
|
|
var
|
|
object = instance,
|
|
maxDepth,
|
|
found,
|
|
response
|
|
;
|
|
passedArguments = passedArguments || queryArguments;
|
|
context = element || context;
|
|
if(typeof query == 'string' && object !== undefined) {
|
|
query = query.split(/[\. ]/);
|
|
maxDepth = query.length - 1;
|
|
$.each(query, function(depth, value) {
|
|
var camelCaseValue = (depth != maxDepth)
|
|
? value + query[depth + 1].charAt(0).toUpperCase() + query[depth + 1].slice(1)
|
|
: query
|
|
;
|
|
if( $.isPlainObject( object[camelCaseValue] ) && (depth != maxDepth) ) {
|
|
object = object[camelCaseValue];
|
|
}
|
|
else if( object[camelCaseValue] !== undefined ) {
|
|
found = object[camelCaseValue];
|
|
return false;
|
|
}
|
|
else if( $.isPlainObject( object[value] ) && (depth != maxDepth) ) {
|
|
object = object[value];
|
|
}
|
|
else if( object[value] !== undefined ) {
|
|
found = object[value];
|
|
return false;
|
|
}
|
|
else {
|
|
module.error(error.method, query);
|
|
return false;
|
|
}
|
|
});
|
|
}
|
|
if ( $.isFunction( found ) ) {
|
|
response = found.apply(context, passedArguments);
|
|
}
|
|
else if(found !== undefined) {
|
|
response = found;
|
|
}
|
|
if($.isArray(returnedValue)) {
|
|
returnedValue.push(response);
|
|
}
|
|
else if(returnedValue !== undefined) {
|
|
returnedValue = [returnedValue, response];
|
|
}
|
|
else if(response !== undefined) {
|
|
returnedValue = response;
|
|
}
|
|
return found;
|
|
}
|
|
};
|
|
|
|
if(methodInvoked) {
|
|
if(instance === undefined) {
|
|
module.initialize();
|
|
}
|
|
module.invoke(query);
|
|
}
|
|
else {
|
|
if(instance !== undefined) {
|
|
instance.invoke('destroy');
|
|
}
|
|
module.initialize();
|
|
}
|
|
})
|
|
;
|
|
|
|
return (returnedValue !== undefined)
|
|
? returnedValue
|
|
: this
|
|
;
|
|
};
|
|
|
|
$.fn.nag.settings = {
|
|
|
|
name : 'Nag',
|
|
|
|
debug : false,
|
|
verbose : false,
|
|
performance : true,
|
|
|
|
namespace : 'Nag',
|
|
|
|
// allows cookie to be overriden
|
|
persist : false,
|
|
|
|
// set to zero to require manually dismissal, otherwise hides on its own
|
|
displayTime : 0,
|
|
|
|
animation : {
|
|
show : 'slide',
|
|
hide : 'slide'
|
|
},
|
|
|
|
context : false,
|
|
detachable : false,
|
|
|
|
expires : 30,
|
|
domain : false,
|
|
path : '/',
|
|
|
|
// type of storage to use
|
|
storageMethod : 'cookie',
|
|
|
|
// value to store in dismissed localstorage/cookie
|
|
key : 'nag',
|
|
value : 'dismiss',
|
|
|
|
error: {
|
|
noCookieStorage : '$.cookie is not included. A storage solution is required.',
|
|
noStorage : 'Neither $.cookie or store is defined. A storage solution is required for storing state',
|
|
method : 'The method you called is not defined.'
|
|
},
|
|
|
|
className : {
|
|
bottom : 'bottom',
|
|
fixed : 'fixed'
|
|
},
|
|
|
|
selector : {
|
|
close : '.close.icon'
|
|
},
|
|
|
|
speed : 500,
|
|
easing : 'easeOutQuad',
|
|
|
|
onHide: function() {}
|
|
|
|
};
|
|
|
|
})( jQuery, window, document );
|