Is the function .swap() ever useful?

Question

Browsing through the source of 1.7rc1, line 6625, I've found the .swap function:

// A method for quickly swapping in/out CSS properties to get correct calculations
swap: function( elem, options, callback ) {
    var old = {};

    // Remember the old values, and insert the new ones
    for ( var name in options ) {
        old[ name ] = elem.style[ name ];
        elem.style[ name ] = options[ name ];
    }

    callback.call( elem );

    // Revert the old values
    for ( name in options ) {
        elem.style[ name ] = old[ name ];
    }
}

I've never seen it used before. Do people actually use it? For what?

It's a private function ([not](http://api.jquery.com/swap) [documented](http://api.jquery.com/jQuery.swap)) so it's clearly not for jQuery _users._ — Matt Ball, Oct 27 '11 at 19:27
If you look a few lines down, you will see it being used.. It is most likely for internal use.. — Gabriele Petrioli, Oct 27 '11 at 19:31
See http://stackoverflow.com/questions/2861671/hidden-div-height-changing-my-advice and http://www.foliotek.com/devblog/getting-the-width-of-a-hidden-element-with-jquery-using-width/ — Petr, Oct 27 '11 at 19:39

score 1 · Accepted Answer · edited Sep 02 '21 at 01:27

.swap(elem, options, callback) is a function that temporarily sets a number of CSS values (those passed in object of the 2nd argument), calls the callback (the 3rd argument) and then restores the original CSS values after the callback returns.

jQuery uses it for temporarily changing the layout of things in order to do some measurements. For example, if you take a div object and set it to position: absolute, you will be able to get it's true width, but if it's in the normal layout of the document, a div takes the width of it's container. If you step through a jQuery call to .width() or look at how that function is implemented in the source, you will see it being used.

I'm sure you could invent/find something else to use it for, but I've not found a need for it other than the measurement types of use that jQuery is using it for.

Is the function .swap() ever useful?

1 Answers1