jQuery Plugin Syntax/ JavaScript Syntax?

Question

I came across this syntaxt many times, in JavaScript or jQuery plugin

$.fn.testPlugin = function( options ) {  

    // Create some defaults, extending them with any options that were provided
    var settings = $.extend( {
      'location'         : 'top',
      'background-color' : 'blue'
    }, options);

I do understand that the function is extended but what after $.extend({}) is not clear to me.

“what after $.extend({})” is precisely what this fragment is not showing. — dumbass
– dumbass, Commented Nov 28, 2024 at 12:14

Alnitak · Accepted Answer · 2013-03-20 13:03:43Z

2

The $.extend() method will merge any key/value pairs given in objects in the the second (and subsequent) parameter into the object passed in the first parameter. It then returns the (updated) first parameter as its result.

Hence this is just a way of specifying some default values for those two options, which will be overridden by any that the plugin user passes in the options parameter to the plugin.

For example, if you called:

$(el).testPlugin({ location: 'left' });

then within the plugin the resulting settings will be:

var settings = {
    location:         'left',
    background-color: 'blue'
};

edited Mar 20, 2013 at 13:03

answered Mar 20, 2013 at 12:57

Alnitak

341k72 gold badges420 silver badges503 bronze badges

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

Comments

Dor Cohen · Accepted Answer · 2013-03-20 12:59:04Z

0

jQuery.extend() is syntax for merging the contents of two or more objects together into the first object. http://api.jquery.com/jQuery.extend/

answered Mar 20, 2013 at 12:59

Dor Cohen

17.1k24 gold badges97 silver badges161 bronze badges

Collectives™ on Stack Overflow

jQuery Plugin Syntax/ JavaScript Syntax?

2 Answers 2

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related