jQuery Plugin Template

jq_plugin.js

// jQuery Plugin Boilerplate
// A boilerplate for jumpstarting jQuery plugins development
 
;(function($) {
 
    $.pluginName = function(el, options) {
 
        var defaults = {
            propertyName: 'value',
            onSomeEvent: function() {}
        }
 
        var plugin = this;
 
        plugin.settings = {}
 
        var init = function() {
            plugin.settings = $.extend({}, defaults, options);
            plugin.el = el;
            // code goes here
        }
 
        plugin.foo_public_method = function() {
            // code goes here
        }
 
        var foo_private_method = function() {
            // code goes here
        }
 
        init();
 
    }
 
})(jQuery);

/*
 * Usage for the plugin 
 */

$(document).ready(function() {
 
    // create a new instance of the plugin
    var myplugin = new $.pluginName($('#element'));
 
    // call a public method
    myplugin.foo_public_method();
 
    // get the value of a public property
    myplugin.settings.property;
 
});