Advanced jQuery Boilerplate
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
README.md
advanced-jquery-boilerplate.js
advanced-jquery-boilerplate.min.js
test.html

README.md

Advanced jQuery Boilerplate

A jQuery plugin to create scalable jQuery plugins, fast!

Sample Plugin: jQuery Tabslide

How To

To register a new plugin provide a plugin name, default options, public methods and global methods (if any):

(function($, win, doc, undefined) {

  var pluginName, defaults, methods, global;

  // The name of your plugin
  pluginName = 'myplugin';

  // Default options
  defaults = {

  };

  // Public methods
  methods = {

    // Gets called when creating a new instance
    // this.el is the element on which the plugin was called
    // this.opts contains the options passed to the plugin
    _init: function() {
      this.$el = $(this.el);
    },

    method: function() {

    }
  };

  // Global properties and methods get attached to `$`
  // as opposed to `$.fn` so they can be extended from the outside
  global = {

  };

  // Add the plugin to the jQuery namespace and set-up the boilerplate base
  $.newPlugin(pluginName, defaults, methods, global);

}(jQuery, window, document));

Usage

Now you can use your new plugin on any jQuery collection like so:

// Attach a new instance and run the `init` method
$('selector').myplugin({ options }); 

The plugin attaches an instance of itself to the element(s) so after you initialize it you can call any method by calling the plugin again with the name of the method and its arguments:

$('selector').myplugin('method', arg1, arg2, ...);

All methods return this so everything can be chained by default. If you want to get the returned value of a method, prefix the call with get::

$('selector').myplugin('get:method', arg1, arg2, ...);  

You can access the current instance of the plugin with data:

$instance = $('selector').data('myplugin');
$instance.property;
$instance.method();