Methods
Masonry offers several methods to extend functionality. Masonry’s methods follow the jQuery UI pattern.
$('#container').masonry( 'methodName', [optionalParameters] )
appended
.masonry( 'appended', $content, isAnimatedFromBottom )
Triggers layout
on item elements that have been appended to the container.
var $boxes = $('<div class="box"/><div class="box"/><div class="box"/>');
$('#container').append( $boxes ).masonry( 'appended', $boxes );
Setting the isAnimatedFromBottom
argument to true
will enable the newly appended items to be animated from the bottom, if animation is enabled.
$('#container').append( $boxes ).masonry( 'appended', $boxes, true );
The appended
method is ideal to use Masonry with Infinite Scroll, in its callback.
var $container = $('#container');
$container.infinitescroll({
// infinite scroll options...
},
// trigger Masonry as a callback
function( newElements ) {
var $newElems = $( newElements );
$container.masonry( 'appended', $newElems );
}
);
destroy
.masonry( 'destroy' )
Removes Masonry functionality completely. Returns element back to pre-initialized state.
layout
.masonry( 'layout', $items, callback )
Positions specified item elements in layout.
layout
will only position specified elements, and those elements will be positioned at the end of layout. Whereas .masonry()
will position all items in the Masonry instance.
option
.masonry( 'option', options )
Sets options for plugin instance. Unlike passing options through .masonry()
, using the option
method will not trigger layout.
// set multiple options
.masonry( 'option', { columnWidth: 120, isAnimated: false } )
reloadItems
.masonry( 'reloadItems' )
Re-collects all item elements in their current order in the DOM.
reload
.masonry( 'reload' )
Convenience method for triggering reloadItems
then .masonry()
. Useful for prepending or inserting items.
var $boxes = $('<div class="box"/><div class="box"/><div class="box"/>');
$('#container').prepend( $boxes ).masonry( 'reload' );
remove
.masonry( 'remove', $items )
Removes specified item elements from Masonry instance and the DOM.