creating a jquery plugin on the jquery core $ object

Question

I would like to create a plugin for jquery that doesn't work with the dom. I therefore don't need to use a jquery object from the $ function. I would like to make my own function called

$.shortcut(keys,action)

Icould probably just go

$.prototype.shortcut = function(){//my code}

but I would like to know if that's the best way to go about this.

simshaun · Accepted Answer · 2011-06-06 21:17:37Z

3

You just about have it already...

$.shortcut = function(keys, action) {
    // code
}

I prefer to wrap mine in an anon function and pass jQuery as a param though. It helps avoid naming conflicts and makes for easier minification.

(function($){
    $.shortcut = function(keys, action) {
        // code
    }
})(jQuery);

answered Jun 6, 2011 at 21:17

simshaun

21.5k1 gold badge60 silver badges73 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Rob Over a year ago

This would also work best in a closure. This way you can reference the jQuery object as $ and know that it will work with noConflict: docs.jquery.com/Plugins/Authoring

icktoofay · Accepted Answer · 2011-06-06 21:16:39Z

1

Drop the .prototype part, and then it'll the way it's usually done. (except usually you use jQuery instead of $ in case the person is using noConflict)

answered Jun 6, 2011 at 21:16

icktoofay

130k23 gold badges261 silver badges239 bronze badges

Collectives™ on Stack Overflow

creating a jquery plugin on the jquery core $ object

2 Answers 2

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related