Superior jQuery plugin template

#1

Post by nvitas » Mon, Mar 19, 2012, 4:20 PM UTC

Superior jQuery plugin template
websanova.com

Re: Superior jQuery plugin template

#2

Post by AndrewHampton » Mon, Mar 19, 2012, 4:39 PM UTC

The first line of $.fn.wTooltip is

  if(typeof option === 'object')

Does anyone know where option is declared and where its value is set?

Re: Superior jQuery plugin template

#3

Post by rduchnik » Mon, Mar 19, 2012, 4:46 PM UTC

AndrewHampton wrote: post #2

The first line of $.fn.wTooltip is if(typeof option === 'object') Does anyone know where option is declared and where its value is set?

My bad, fixed it, was supposed to be here:

    $.fn.wTooltip = function(option, settings)

Re: Superior jQuery plugin template

#4

Post by lhorie » Mon, Mar 19, 2012, 4:48 PM UTC

AndrewHampton wrote: post #2

The first line of $.fn.wTooltip is if(typeof option === 'object') Does anyone know where option is declared and where its value is set?

It's meant to be the first argument passed to the plugin, e.g.

  $("#bla").wTooltip({foo: "bar"})

Re: Superior jQuery plugin template

#5

Post by ftyhgjn » Mon, Mar 19, 2012, 4:58 PM UTC

rduchnik wrote: post #3

AndrewHampton wrote: post #2

The first line of $.fn.wTooltip is if(typeof option === 'object') Does anyone know where option is declared and where its value is set?

My bad, fixed it, was supposed to be here: $.fn.wTooltip = function(option, settings)

'Untested' and 'superior' are not happy bedfellows!

Re: Superior jQuery plugin template

#6

Post by deadbeef84 » Mon, Mar 19, 2012, 5:18 PM UTC

Here's my thoughts:

1. Ability to modify default settings It is sometimes nice to set the global defaults.

2. Ability to expose methods. A nice way of calling the someFunc() would be nice. I guess you can do it like this: $(...).data('_wTooltip').someFunc(); but using the data() seems a bit hacky.

3. Use settings from html5 data-attribute, ie data-tooltip='{"foo":"baar"}'. Not really necessary for the example plugin, but I think it could be for others. I hate it when I need initialize every instance separately just to specify it's options, when they could be specified in the markup.

4. Missing var before $settings. Just a typo I guess?

5. I think the name generate() is a bit misleading, init() or initialize() makes more sense to me.

Re: Superior jQuery plugin template

#7

Post by deadbeef84 » Mon, Mar 19, 2012, 5:22 PM UTC

deadbeef84 wrote: post #6

Here's my thoughts: 1. Ability to modify default settings It is sometimes nice to set the global defaults. 2. Ability to expose methods. A nice way of calling the someFunc() would be nice. I guess you can do it like this: $(...).data('_wTooltip').someFunc(); but using the data() seems a bit hacky. 3. Use settings from html5 data-attribute, ie data-tooltip='{"foo":"baar"}'. Not really necessary for the example plugin,…

6. Prevention of double instantiation.

Re: Superior jQuery plugin template

#8

Post by rduchnik » Mon, Mar 19, 2012, 5:25 PM UTC

ftyhgjn wrote: post #5

rduchnik wrote: post #3

Earlier quoted context omitted.

My bad, fixed it, was supposed to be here: $.fn.wTooltip = function(option, settings)

'Untested' and 'superior' are not happy bedfellows!

lol, just a typo ;)

Re: Superior jQuery plugin template

#9

Post by robin_reala » Mon, Mar 19, 2012, 5:27 PM UTC

deadbeef84 wrote: post #6

Here's my thoughts: 1. Ability to modify default settings It is sometimes nice to set the global defaults. 2. Ability to expose methods. A nice way of calling the someFunc() would be nice. I guess you can do it like this: $(...).data('_wTooltip').someFunc(); but using the data() seems a bit hacky. 3. Use settings from html5 data-attribute, ie data-tooltip='{"foo":"baar"}'. Not really necessary for the example plugin,…

Not sure you should be (ab)using data- attributes like that. They’re already a key/value pair so you markup your data as

Re: Superior jQuery plugin template

#10

Post by rduchnik » Mon, Mar 19, 2012, 5:35 PM UTC

deadbeef84 wrote: post #6

Here's my thoughts: 1. Ability to modify default settings It is sometimes nice to set the global defaults. 2. Ability to expose methods. A nice way of calling the someFunc() would be nice. I guess you can do it like this: $(...).data('_wTooltip').someFunc(); but using the data() seems a bit hacky. 3. Use settings from html5 data-attribute, ie data-tooltip='{"foo":"baar"}'. Not really necessary for the example plugin,…

I like your points for 1 and 2, will add those in the next iteration, constantly trying to improve this thing.

I didn't use init() because sometimes I may use init to do something else that doesn't deal with generating the plugin code, so I ended up going with generate(), maybe create() would be a better word.