Comments on: jQuery Plugin Boilerplate

By: Vall

Vall — Thu, 19 Apr 2012 10:06:15 +0000

Hello,

first of all, nice boilerplate. Was looking for something similar for a while now. I’m having a problem with initializing it, the line:
var myplugin = new $.pluginName($(‘#element’));

returns:
TypeError: $.pluginName is not a constructor

Any idea what I’m doing wrong?
#element exists and myplugin variable is not defined before initialization.

Thanks!

By: Rob

Rob — Wed, 28 Mar 2012 01:43:37 +0000

That’s a nice boilerplate, I would also include the ability to modify existing settings though like in this one: http://www.websanova.com/tutorials/jquery/jquery-plugin-development-boilerplate

By: Stefan Gabos

Stefan Gabos — Fri, 02 Mar 2012 04:40:07 +0000

so that developers can perform specific tasks at specific time points; like jQuery’s animate(), which executes a function when it’s done.

By: John

John — Tue, 28 Feb 2012 16:53:19 +0000

What is the point of the callback methods (like onSomeEvent()) in the defaults? Why not just use public functions?

Thanks!

By: Joseph

Joseph — Sat, 25 Feb 2012 08:46:27 +0000

Thanks for this awesome template. However, I noticed that to start the plugin, you need this “messy code” to do it:

var myplugin = new $.pluginName($(‘#element’),{options…});

why not send the selector string:

var myplugin = new $.pluginName(‘#element’,{options…});

and in the plugin template, do this:

plugin.el = $(el);

By: Stefan Gabos

Stefan Gabos — Fri, 20 Jan 2012 08:03:29 +0000

yes, that's pretty much it. i do it like this:

// first make sure that there is a callback function 
if (plugin.settings.onSomeEvent && typeof plugin.settings.onSomeEvent== 'function')

    // execute the callback function
    plugin.settings.onSomeEvent(arg1, arg2, ... argn);

By: Stefan Gabos

Stefan Gabos — Fri, 20 Jan 2012 08:01:31 +0000

it’s common sense: just create the plugin like

$.pluginName = function(options) {

and remove all the references to el…

By: P.J.

P.J. — Fri, 20 Jan 2012 01:19:40 +0000

One more question, how would I trigger the object's event hooks (set in the defaults variable)? For example, if I wanted to trigger onSomeEvent when an input's value was changed or a button was clicked, is this the proper way to do it?

myplugin.settings.onSomeEvent;

Thanks!

By: P.J.

P.J. — Thu, 19 Jan 2012 21:39:33 +0000

Great thanks! Now for another question:

I’m using your boilerplate template for a plugin that will accept several options and do a lot of editing on different dom elements, Ajax calls, etc. I’ll need to pass in options, but there’s no need to pass in “el” since the plugin doesn’t need to be attached to any specific element.

Should I just create an empty span element or something, and ignore the “el” parameter?

By: Stefan Gabos

Stefan Gabos — Tue, 17 Jan 2012 07:55:58 +0000

just use $.noConflict() after loading jQuery but before running any jQuery code, and that should take care of everything read more at http://api.jquery.com/jQuery.noConflict/