jQuery Plugin Template

jquery.plugintemplate.js

(function($) {

    var PLUGIN = ""  //TODO: The name of the plugin

    var methods = {
        init: function (config) {
            var options = {


                //TODO: Default Options


            }
            $.extend(options, config)
            return this.each(function() {
                var $this = $(this),
                    data = $this.data(PLUGIN);

                if (!data) {
                    data = {
                        //instance variables
                        target: $this,
                    };
                    $this.data(PLUGIN, data);


                    //TODO: Constructor

                    
                }
            });
        },
        destroy: function() {
            return this.each(function() {
                var $this = $(this),
                data = $this.data(PLUGIN);


                //TODO: Destructor


                // remove data
                $this.removeData(PLUGIN);
                //unbind namespaced events
                $(window).unbind('.'+PLUGIN);
            });
        },


        //TODO: Class Methods


    };

    $.fn[PLUGIN] = function(method) {
        if (methods[method]) {
            return methods[method].apply(this, Array.prototype.slice.call(arguments, 1));
        }
        else if (typeof method == 'object' || !method) {
            return methods.init.apply(this, arguments);
        } else {
            $.error('Method '+method+'does not exist on jQuery.'+PLUGIN);
        }
    }

})(jQuery);