Skip to content

Instantly share code, notes, and snippets.

@mrrooijen
Created July 29, 2009 11:04
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save mrrooijen/157997 to your computer and use it in GitHub Desktop.
Save mrrooijen/157997 to your computer and use it in GitHub Desktop.
A jQuery Plugin Template.
(function($){
/**
* jQuery PluginName
*
* @plugin {PluginName}
* @description {PluginDescription}
*
* @changelog
* @{mm/dd/yyyy} {version} {author} {changedescription}
*
* @author Michael van Rooijen
* @version 0.1
* @updated dd/mm/yyyy
*/
$.fn.invoke_method_name = function(options) {
/**
* @var defaults [object]
* Plugin's default initial settings, can be overwritten by user if options are applied.
*/
var defaults = {
};
/**
* @var settings [object]
* Merge Default Settings with User Custom Input
*/
var settings = $.extend({}, defaults, options);
/**
* @var object [object]
* A object to work with
*/
var object = {}
/**
* Initial
* Loops through each of the specified element(s) that's available inside the current document
*/
this.each(function(){
});
/**
* @method {name}
* {methods description}
*/
object.method = function()
{
};
/**
* returns the tooltip object so more jQuery chaining can be applied afterwards
*/
return this;
};
})(jQuery);
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment