Skip to content

Instantly share code, notes, and snippets.

@michealbenedict
Created May 22, 2011 12:08
Show Gist options
  • Save michealbenedict/985404 to your computer and use it in GitHub Desktop.
Save michealbenedict/985404 to your computer and use it in GitHub Desktop.
Simple jQuery Timer Plugin
/*
* @Module Timer
* @author : Micheal
*
* @usage:
$(document).ready(function() {
$(".s1").timer({
from: 100, //sec
end: function() {
console.log('triggerd at the end of timer')
},
tick: function(current_sec) {
console.log(current_sec);
}
});
});
* @license
(The MIT License)
Copyright (c) 2011 Micheal Benedict Arul
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
/*global setInterval, clearTimeout, jQuery */
(function($) {
function timer(defaults, callback) {
var count = defaults.from;
var countdown_interval;
countdown_interval = setInterval(function(){
if (count === 0) {
if(typeof(callback) === "function") {
callback(countdown_interval);
}
}
if(typeof defaults.tick === 'function' && count > 0) {
defaults.tick(count);
}
count--;
}, 1000);
return countdown_interval;
}
$.fn.timer = function(opt) {
var params = opt || {},
defaults = $.extend({
from: 720,
tick: function() { },
end: function() { }
},params);
var $this = $(this[0] || this),
data = $this.data('timer');
if(data) {
if(typeof params.end === "undefined") {
defaults.end = data.defaults.end;
}
if(typeof params.tick === "undefined") {
defaults.tick = data.defaults.tick;
}
clearTimeout(data.countdown);
$this.removeData("timer");
}
$this.data('timer',{
target: $this,
defaults: defaults,
countdown: timer(defaults, function(countdown) {
clearTimeout(countdown);
if(typeof defaults.end === 'function') {
defaults.end();
}
})
});
};
}(jQuery));
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment