Last active
January 1, 2016 14:49
-
-
Save raspo/8159972 to your computer and use it in GitHub Desktop.
A starting template for building jquery plugins
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/* global jQuery: true*/ | |
// the semi-colon before function invocation is a safety net against concatenated | |
// scripts and/or other plugins which may not be closed properly. | |
; | |
(function($, window, document, undefined) { | |
'use strict'; | |
// undefined is used here as the undefined global variable in ECMAScript 3 is | |
// mutable (ie. it can be changed by someone else). undefined isn't really being | |
// passed in so we can ensure the value of it is truly undefined. In ES5, undefined | |
// can no longer be modified. | |
// window and document are passed through as local variable rather than global | |
// as this (slightly) quickens the resolution process and can be more efficiently | |
// minified (especially when both are regularly referenced in your plugin). | |
// Create the defaults once | |
var pluginName = 'circularProgress', | |
defaults = {}; | |
// The actual plugin constructor | |
function Plugin(element, options) { | |
this.element = element; | |
this.$el = $(element); | |
this.options = $.extend({}, defaults, options); | |
this._defaults = defaults; | |
this._name = pluginName; | |
this.init(); | |
} | |
Plugin.prototype = { | |
init: function() {} | |
}; | |
// A really lightweight plugin wrapper around the constructor, | |
// preventing against multiple instantiations | |
$.fn[pluginName] = function(option) { | |
return this.each(function() { | |
var $this = $(this), | |
data = $.data(this, 'plugin_' + pluginName), | |
options = typeof option === 'object' && option; | |
if (!data) { | |
$this.data('plugin_' + pluginName, (data = new Plugin(this, options))); | |
} | |
// if first argument is a string, call silimarly named function | |
// this gives flexibility to call functions of the plugin e.g. | |
// - $('.dial').plugin('destroy'); | |
// - $('.dial').plugin('render', $('.new-child')); | |
if (typeof option === 'string') { | |
data[option](Array.prototype.slice.call(arguments), 1); | |
} | |
}); | |
}; | |
})(jQuery, window, document); |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment