isotope/_posts/docs/2011-12-11-help.mdown

title: Help category: docs layout: default toc: - { title: Reporting bugs and issues, anchor: reporting_bugs_and_issues } - { title: Additional resources, anchor: additional_resources } - { title: Unloaded media, anchor: unloaded_media } - { title: Images, anchor: images } - { title: @font-face fonts, anchor: fontface_fonts } - { title: Problems with CSS transforms, anchor: css-transforms } - { title: Getting item position, anchor: getting_item_position } - { title: Accessing the instance, anchor: accessing_the_instance } - { title: CSS transforms in Opera, anchor: css_transforms_in_opera } - { title: Infinite Scroll with filtering or sorting, anchor: infinite_scroll_with_filtering_or_sorting} - { title: Poor type rendering in WebKit, anchor: poor_type_rendering_in_webkit } - { title: First item breaks Masonry layout, anchor: first_item_breaks_masonry_layout } - { title: Right-to-left layouts, anchor: righttoleft_layouts } - { title: Preventing clicks on filtered items, anchor: unclickable-filtered }

Reporting bugs and issues

Report bugs and issues on GitHub.

Guidelines {: #issues-guidelines}

• Look over open and closed issues before submitting yours.
• Add a link to a live site with the bug. If the project is confidential, try re-creating it in jsFiddle.

The issues tracker is for bugs and issues — when Isotope doesn't work as expected. It is not for implementation issues — when you are having trouble setting up Isotope. I am unable to personally help with implementation issues but don't give up!

Additional resources

• The Metafizzy blog has posts that cover specialized use cases
• Sites using Isotope on Zootool, has screenshots
• Sites using Isotope on Delicious
• Miscelleanous Isotope content
• Stack Overflow questions on Isotope

Unloaded media

Most layout modes (i.e masonry, fitRows) need to measure the size of each item to appropriately account for its space in the layout. Unloaded media files like images and @font-face fonts can throw off layout and cause item elements to overlap one another. Ideally, Isotope layouts should be initialized after all inner content has loaded.

Images

Inline dimensions

For images, the best method is to specify the width and height of images inline.

{% highlight html %}

{% endhighlight %}

If you’re using a PHP-based CMS, you can use the getimagesize function.

imagesLoaded plugin

The next best solution is to use the imagesLoaded plugin included with Isotope. It's a small plugin that finds all the images in a context, and fires a callback function once all the images have loaded.

{% highlight javascript %}

var $container = $('#container');

$container.imagesLoaded( function(){ $container.isotope({ // options... }); });

{% endhighlight %}

$(window).load()

Another solution is to initialize Isotope inside $(window).load() instead of $(document).ready(). This will trigger Isotope after all the media on the page has loaded.

{% highlight javascript %}

$(window).load(function(){ $('#container').isotope({ // options... }); });

{% endhighlight %}

@font-face fonts

Both Typekit and Google WebFont Loader provide font events to control scripts based on how fonts are loaded.

• Typekit font events
• Google WebFont Loader: Events

Problems with CSS transforms {: #css-transforms}

As the browser implementations of CSS tranforms are still a work-in-progress, they can cause buggy behavoir with other types of dynamic content.

• Flash content in Safari and Firefox, like YouTube or Vimeo videos, Flash ads, or Flash audio players.

Disabling transforms

Set transformsEnabled to false. This is an easy step to take when troubleshooting.

{% highlight javascript %}

$('#container').isotope({ // options... transformsEnabled: false });

{% endhighlight %}

Getting item position

CSS transforms will break previous patterns for getting the position of an item. See the itemPositionDataEnabled option for a stop-gap.

Accessing the instance

Similar to jQuery UI, Isotope stores a instance containing properties, settings and methods with jQuery.data. You can access the instance with the 'isotope' namespace.

{% highlight javascript %}

var $container = $('#container');

// initialize Isotope instance $container.isotope({ // options... });

// get Isotope instance var isotopeInstance = $container.data('isotope'); isotopeInstance.options; // options isotopeInstance.$filteredAtoms; // jQuery object of filtered & sorted item elements isotopeInstance.masonry.columnWidth; // Layout mode specific properties

{% endhighlight %}

CSS transforms in Opera

Currently, using CSS transforms in Opera distorts text rendering. To avoid this issue, the default value of transformsEnabled is set to for Opera.

Also note that the recommended transition CSS uses left/top properties for Opera.

Infinite Scroll with filtering or sorting

I recommend against using Infinite Scroll with filtering or sorting. This combination produces a unnecessarily complex user interaction that will frustrate your users. New content gets added, but part of it might be hidden. There is no way for the user to tell what gets hidden or re-arranged when Infinite Scroll adds more content. Exercise moderation with your Isotope implementation.

If you do plan on implementing Infinite Scroll with filtering or sorting (which is a bad idea), use the insert method instead of appended.

Poor type rendering in WebKit

Type rendering may appear poor in WebKit browsers like Chrome and Safari. This is because of Isotope's activation of hardware acceleration. The solution is to add add a matching background to the item elements. See more: dropshado.ws - Resolving anti-aliasing on WebKit hardware-accelerated elements.

First item breaks Masonry layout

With Masonry layout mode If you run into an issue where you re-size the first item, and all the rest of the items no longer fit together in the grid, you most likely need to set columnWidth option. Without columnWidth set, the Masonry layout mode will use the width of the first item for the size of its columns.

{% highlight javascript %}

$('#container').isotope( masonry: { columnWidth: 220 } });

{% endhighlight %}

Right-to-left layouts

Isotope can be modified to support right-to-left layouts for languages like Hebrew and Arabic.

See test: Right to left

You'll need to make the following changes:

• Modify Isotope's _positionAbs method
• Set transformsEnabled: false in the Isotope options
• Add CSS transition property styles for right/top.

JavaScript for right-to-left support

{% highlight javascript %}

// modify Isotope's absolute position method $.Isotope.prototype._positionAbs = function( x, y ) { return { right: x, top: y }; };

// initialize Isotope $('#container').isotope({ transformsEnabled: false // other options... });

{% endhighlight %}

CSS for right-to-left support

{% highlight css %}

.isotope .isotope-item { -webkit-transition-property: right, top, -webkit-transform, opacity; -moz-transition-property: right, top, -moz-transform, opacity; -o-transition-property: right, top, -o-transform, opacity; transition-property: right, top, transform, opacity; }

{% endhighlight %}

Preventing clicks on filtered items {: #unclickable-filtered}

The recommended CSS for filtering includes pointer-events: none for .isotope-hidden. Unfortunately, Opera and Internet Explorer still let click events propagate with this style in place. But you can still dismiss click events in your click handler by checking to see if the element or element's parent is a filtered item.

See test: Unclickable filtered

{% highlight javascript %}

$('.item a').click(function(){ var $this = $(this); // back out if hidden item if ( $this.parents('.isotope-item').hasClass('isotope-hidden') ) { return; } // otherwise, continue to do stuff... console.log('item was clicked'); });

{% endhighlight %}