jquery.plugin.js

/**
 * jQuery Plugin Starting Point - A base jquery plugin template
 *
 * Use this template as a base to create any jQuery plugin.
 * has UMD/AMD support
 * also contains a super cool way to register plugins that could be forked out
 *
 * Licensed under the MIT:
 * http://www.opensource.org/licenses/mit-license.php
 *
 * @author Will Ayers ( @cointilt )
 * @version 2.0
 * @link https://github.com/cointilt/jQuery-Plugin-Starting-Point
*/

;(function (factory) {
	if (typeof define == 'function' && define.amd) {
		// AMD define
		define(['jquery'], factory);
	} else {
		// default no AMD/UMD way
		factory(jQuery);
	}
}(function ($) {
	// Plugin name and Default app variable
	var pluginName = 'myPlugin',
		App = {};

	// Plugin initialize function
	App.init = function (options, el) {
		// default options
		var defaults = {};

		// combine default options with passed in options
		this.options = $.extend({}, defaults, options);

		// setup elements
		this.el = el;
		this.$el = $(el);

		// return this for chaining
		return this;
	};

	// get option
	App.option = function (name) {
		return this.options[name];
	};

	// create missing function on crappy browsers
	if (typeof Object.create !== 'function') {
		Object.create = function (o) {
			function F() {}
			F.prototype = o;
			return new F();
		};
	}

	// custom way of registering plugins
	// this could be taken out and added in it's own file
	$.registerPlugin = function (name, object) {
		$.fn[name] = function (options) {
			return this.each(function () {
				if (!$.data(this, name)) {
					$.data(this, name, Object.create(object).init(options, this));
				}
			});
		};
	};

	// register App as a jQuery Plugin
	$.registerPlugin(pluginName, App);

	// return the app the be able to call specific if needed
	return App;
}));