Appendix
imagesLoaded
没有被加载的图片会破坏Isotope的布局,并造成元素项之间相互重叠。可以使用imagesLoaded来解决这个问题。imagesLoaded可以在所有的图片被加载之后返回一个回调函数。
// initialize Isotope after all images have loaded
var $container = $('#container').imagesLoaded( function() {
$container.isotope({
// options
});
});
// or with vanilla JS
var container = document.querySelector('#container');
var iso;
// initialize Isotope after all images have loaded
imagesLoaded( container, function() {
iso = new Isotope( container, {
// options
});
});
或者先初始化Isotope,然后在图片加载之后使用layout
来布局。
// initialize Isotope
var $container = $('#container').isotope({
// options
});
// layout Isotope again after all images have loaded
$container.imagesLoaded( function() {
$container.isotope('layout');
});
// or with vanilla JS
// initialize Isotope
var iso = new Isotope( container, {
// options
});
// layout Isotope again after all images have loaded
imagesLoaded( container, function() {
iso.layout();
});
Web fonts
Like images, unloaded web fonts can throw off Isotope. To resolve this, trigger layout
after fonts have been loaded. Both Typekit and Google WebFont Loader provide font events to control scripts based on how fonts are loaded.
Typekit
Try the script below when using Isotope on a page with Typekit. This will trigger Isotope when the document is ready and again when fonts have loaded. Be sure to remove Typekit’s default script, try{Typekit.load();}catch(e){}
.
var $container;
function triggerIsotope() {
// don't proceed if $container has not been selected
if ( !$container ) {
return;
}
// init Isotope
$container.isotope({
// options
});
}
// trigger Isotope on document ready
$(function(){
$container = $('#container');
triggerIsotope();
});
// trigger Isotope when fonts have loaded
Typekit.load({
active: triggerIsotope,
inactive: triggerIsotope
});
// or with vanilla JS
var container, iso;
function triggerIsotope() {
// don't proceed if doc isn't ready
if ( !container ) {
return;
}
// init Isotope
iso = new Isotope( container, {
// options
});
}
// initialize Isotope on document ready
docReady( function() {
var container = document.querySelector('#container');
triggerIsotope();
});
// trigger Isotope when fonts have loaded
Typekit.load({
active: triggerIsotope,
inactive: triggerIsotope
});
Support
- Having trouble setting up Isotope?
- Running into a time-consuming problem?
CodersClan has a dedicated support forum for Isotope, where you can get personal support from experienced developers.
Submitting issues
Submit bugs and issues to the GitHub issue tracker.
Reduced test case required
All bug reports and problem issues require a reduced test case. Create one by forking any one of the CodePen examples from these docs.
- A reduced test case clearly demonstrates the bug or issue.
- It contains the bare minimum HTML, CSS, and JavaScript required to demonstrate the bug.
- A link to your production site is not a reduced test case.
Providing a reduced test case is the best way to get your issue addressed. Without a reduced test case, your issue may be closed.
Upgrading from v1
New features
- Custom CSS no longer required.
- jQuery no longer required. Isotope works with vanilla JavaScript.
layoutComplete
event.getSortData
shortcut strings.- Way better support for responsive web design with element sizing options.
Changes
- smartresize jQuery plugin removed.
- imagesLoaded no longer included, but is still recommended.
animationOptions
removed. jQuery animation removed. This means no animation for IE8 and IE9.isResizable
option renamed toisResizeBound
reLayout
method renamed tolayout
layout
method renamed tolayoutItems
transformsEnabled
option removed. Transforms are still used, but only for transitions.itemPositionDataEnabled
option removed. Item position is now accessible as it is set withleft
andtop
.onLayout
option removed. Use thelayoutComplete
event.
Upgrades to masonry layout mode
- Corner stamp is now integrated as
stamp
option andstamp
method - Centering integrated as the
isFitWidth
option. gutterWidth
option renamed togutter
RequireJS
Isotope supports RequireJS.
You can require isotope.pkgd.js.
requirejs( [
'path/to/isotope.pkgd.js',
], function( Isotope ) {
var iso = new Isotope( '#container', {...});
});
Any layout mode that’s not included, will need to be required separately
requirejs( [
'path/to/isotope.pkgd.js',
'path/to/masonry-horizontal.js'
], function( Isotope ) {
var iso = new Isotope( '#container', {
layoutMode: 'masonryHorizontal'
});
});
To use Isotope as a jQuery plugin with RequireJS and isotope.pkgd.js, you need to run jQuery bridget.
// require the require function
requirejs( [ 'require', 'jquery', 'path/to/isotope.pkgd.js' ],
function( require, $, Isotope ) {
// require jquery-bridget, it's included in isotope.pkgd.js
require( [ 'jquery-bridget/jquery.bridget' ],
function() {
// make Isotope a jQuery plugin
$.bridget( 'isotope', Isotope );
// now you can use $().isotope()
$('#container').isotope({...});
}
);
});
Or, you can manage dependencies with Bower. Set baseUrl to bower_components
and set a path config for all your application code.
requirejs.config({
baseUrl: 'bower_components/',
paths: {
app: '../'
}
});
requirejs( [
'isotope/js/isotope',
'app/my-component.js'
], function( Isotope, myComp ) {
var iso = new Isotope( '#container', {...});
});
You can require Bower dependencies and use Isotope as a jQuery plugin with jQuery Bridget.
requirejs.config({
baseUrl: '../bower_components',
paths: {
jquery: 'jquery/jquery'
}
});
requirejs( [
'jquery',
'isotope/js/isotope',
'jquery-bridget/jquery.bridget'
],
function( $, Isotope ) {
// make Isotope a jQuery plugin
$.bridget( 'isotope', Isotope );
// now you can use $().isotope()
$('#container').isotope({...});
});
Browserify
Isotope works with Browserify. Install Isotope with npm.
npm install isotope-layout
var Isotope = require('isotope-layout');
var iso = new Isotope( '#container', {
// options...
});
Install and require layout modes that are not included.
npm install isotope-cells-by-row
var Isotope = require('isotope-layout');
// add cellsByRow layout mode
require('isotope-cells-by-row')
var iso = new Isotope( '#container', {
layoutMode: 'cellsByRow'
});
To use Isotope as a jQuery plugin with Browserify, you need to use jQuery Bridget
npm install jquery
npm install jquery-bridget
var $ = require('jquery');
var jQBridget = require('jquery-bridget');
var Isotope = require('isotope-layout');
// make Isotope a jQuery plugin
$.bridget( 'isotope', Isotope );
// now you can use $().isotope()
$('#container').isotope({
// options...
});
Animating item size
You cannot transition or animate the size of an item element and properly lay out. But there is a trick — you can animate a child element of the item element.
<div class="isotope">
<!-- items have item-content children element -->
<div class="item">
<div class="item-content"></div>
</div>
...
/* item is invisible, but used for layout
item-content is visible, and transitions size */
.animate-item-size-demo .item,
.animate-item-size-demo .item-content {
width: 60px;
height: 60px;
}
.animate-item-size-demo .item-content {
background: #09D;
transition: width 0.4s, height 0.4s;
/* -webkit-transition -moz, etc, too */
}
/* both item and item content change size */
.animate-item-size-demo .item.is-expanded,
.animate-item-size-demo .item.is-expanded .item-content {
width: 180px;
height: 120px;
}
This technique works on items with responsive, percentage widths. Although, it does require a bit more JS. Check out the example on CodePen to see how it’s done.
#animate-item-size-responsive .item {
width: 20%;
height: 60px;
}
#animate-item-size-responsive .item-content {
width: 100%;
height: 100%;
background: #09D;
transition: width 0.4s, height 0.4s;
/* -webkit-transition -moz, etc, too */
}
/* item has expanded size */
#animate-item-size-responsive .item.is-expanded {
width: 60%;
height: 120px;
}
Component libraries
Isotope includes several vanilla JS component libraries. You might have seen these used in the example code. You can use some of these libraries in your own code.
docReady
docReady triggers initialization logic when the document is ready, just like jQuery's $(document).ready()
. docReady
is used to initialize all the demos in these docs.
docReady( function() {
// document is ready, let's do some fun stuff!
var container = document.querySelector('#container');
var iso = new Isotope( container );
});
eventie
Eventie makes event binding in IE8 legit.
var elem = document.querySelector('#my-elem');
function onElemClick( event ) {
console.log( event.type + ' just happened on #' + event.target.id );
// -> click just happened on #my-elem
}
// bind it
eventie.bind( elem, 'click', onElemClick );
// unbind it
eventie.unbind( elem, 'click', onElemClick );
Extra examples
- Combination filters with functions
- Combination inclusive and exclusive filters with selects and checkboxes. Explanation on issue #771.
- Reveal items on init
- Only filter items, no layout. See issue #675
- Search and filter buttons
- Reveal each image as they load
- Filtering with toggle on/off buttons
- Filtering with URL hash. View debug version to see filter in URL hash.
Additional resources
- The Metafizzy blog has posts that cover specialized use cases
- My answers on Stack Overflow
- Sites using Isotope on Delicious
- Stack Overflow questions about Isotope
- Related Isotope links