isotope README

The project's README from github.com/metafizzy/isotope. As one markdown file: README.md.

Isotope

Filter & sort magical layouts

See isotope.metafizzy.co for complete docs and demos.

Install

Download

CDN

Link directly to Isotope files on unpkg.

<script src="https://unpkg.com/isotope-layout@3/dist/isotope.pkgd.min.js"></script>
<!-- or -->
<script src="https://unpkg.com/isotope-layout@3/dist/isotope.pkgd.js"></script>

Package managers

npm: npm install isotope-layout --save

Bower: bower install isotope-layout --save

License

Commercial license

If you want to use Isotope to develop commercial sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary. Purchase an Isotope Commercial License at isotope.metafizzy.co

Open source license

If you are creating an open source application under a license compatible with the GNU GPL license v3, you may use Isotope under the terms of the GPLv3.

Read more about Isotope's license.

Initialize

With jQuery

$('.grid').isotope({
  // options...
  itemSelector: '.grid-item',
  masonry: {
    columnWidth: 200
  }
});

With vanilla JavaScript

// vanilla JS
var grid = document.querySelector('.grid');
var iso = new Isotope( grid, {
  // options...
  itemSelector: '.grid-item',
  masonry: {
    columnWidth: 200
  }
});

With HTML

Add a data-isotope attribute to your element. Options can be set in JSON in the value.

<div class="grid"
  data-isotope='{ "itemSelector": ".grid-item", "masonry": { "columnWidth": 200 } }'>
  <div class="grid-item"></div>
  <div class="grid-item"></div>
  ...
</div>

By Metafizzy 🌈🐻, 2010–2020

isotope (metafizzy/isotope)

Searching Database…

11.1K ·GitHub
Isotope
What is this?Isotope is a JavaScript library for 'magical layouts': it filters and sorts the items on a web page and animates them into their new positions.
Is it a jQuery plugin or a standalone thing?It is a front-end JavaScript library, not a standalone app: you include the isotope.pkgd.js script on your page and apply it to the elements you want filtered and sorted.
How do I add it to a project?Run npm install isotope-layout (Bower works too), link the file from the unpkg CDN, or download isotope.pkgd.js and include it on your page. Complete docs and demos are at isotope.metafizzy.co.
Do I need jQuery to use it?No. jQuery is one option among three: you can also initialize Isotope with vanilla JavaScript or purely in HTML by adding a data-isotope attribute with your options as JSON, so jQuery is entirely optional.
Can I use it for free in a commercial project?Not automatically. Commercial sites, themes and apps require purchasing an Isotope Commercial License; the free option only applies to open source projects under a GPLv3-compatible license.
Is it tied to masonry-style grids?The masonry-layout package ships as a dependency, so masonry-style packing comes bundled with it; the README itself frames the core job as filtering and sorting layout items.
Is there a minified build for production?Yes: the un-minified isotope.pkgd.js ships next to a minified isotope.pkgd.min.js, and both are also served from the unpkg CDN.
What are similar projects?masonry, muuri, velocity, jquery, chosen, scrollreveal, toastr, material
Which topics is it in?grid, layout, jquery, javascript-library, animation, browser, html, ui, gplv3, web-development, npm, frontend
Creator
metafizzy
Size
1.7 MB
Stars
11.1K
Updated
CommitApr 14Releasev3.0.5Apr 06
Age
15y
Commits · 90 Days