Last active
June 17, 2023 13:41
-
-
Save mateuszwrobel/4009166 to your computer and use it in GitHub Desktop.
jQuery: plugin pattern
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
/*! | |
* jQuery lightweight plugin boilerplate | |
* Original author: @ajpiano | |
* Further changes, comments: @addyosmani | |
* Licensed under the MIT license | |
*/ | |
;(function ( $, window, document, undefined ) { | |
// Create the defaults once | |
var pluginName = "defaultPluginName", | |
defaults = { | |
propertyName: "value" | |
}; | |
// The actual plugin constructor | |
function Plugin( element, options ) { | |
this.element = element; | |
this.options = $.extend( {}, defaults, options) ; | |
this._defaults = defaults; | |
this._name = pluginName; | |
this.init(); | |
} | |
Plugin.prototype.init = function () { | |
// Place initialization logic here | |
// We already have access to the DOM element and | |
// the options via the instance, e.g. this.element | |
// and this.options | |
}; | |
// A really lightweight plugin wrapper around the constructor, | |
// preventing against multiple instantiations | |
$.fn[pluginName] = function ( options ) { | |
return this.each(function () { | |
if ( !$.data(this, "plugin_" + pluginName )) { | |
$.data( this, "plugin_" + pluginName, | |
new Plugin( this, options )); | |
} | |
}); | |
}; | |
})( jQuery, window, document ); |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment