extending jquery on the main element object

Question

I've seen some jquery code where people extend the main object like:

 $('someId').myCustomObject();

Is this possible or am I mistaken? (if yes, how?)

stusmith · Accepted Answer · 2010-04-08 19:38:05Z

3

Yes it's easily possible. The standard pattern for building extensions is:

(function($) {

  $.fn.myCustomObject = function(options) {
    var defaults = { ... };
    var opts = $.extend(defaults, options);

    this.each(function(i) {

      ... // Act on each item, $(this).
      ... // Use opts.blah to read merged options.

    });
  };

})(jQuery);

This allows you to use '$' in the plug-in, yet allows compatibility mode.

edited Apr 8, 2010 at 19:38

answered Feb 5, 2009 at 14:43

stusmith

14.1k9 gold badges59 silver badges89 bronze badges

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

2 Comments

ryonlife Over a year ago

That's the right pattern, except this is already a jQuery object, so you can call this.each() without wrapping it in the jQuery function.

stusmith Over a year ago

Oopsies, my bad. I'll fix it. Cheers.

Rich · Accepted Answer · 2009-02-05 14:30:13Z

0

I believe what you're looking for is jQuery.fn.extend:

jQuery.fn.extend

answered Feb 5, 2009 at 14:30

Rich

36.9k31 gold badges119 silver badges155 bronze badges

Collectives™ on Stack Overflow

extending jquery on the main element object

2 Answers 2

2 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related