86 lines
2.0 KiB
Markdown
86 lines
2.0 KiB
Markdown
# Isotope
|
||
|
||
_Filter & sort magical layouts_
|
||
|
||
See [isotope.metafizzy.co](http://isotope.metafizzy.co) for complete docs and demos.
|
||
|
||
## Install
|
||
|
||
### Download
|
||
|
||
+ [isotope.pkgd.js](https://npmcdn.com/isotope-layout@3/dist/isotope.pkgd.js) un-minified, or
|
||
+ [isotope.pkgd.min.js](https://npmcdn.com/isotope-layout@3/dist/isotope.pkgd.min.js) minified
|
||
|
||
### CDN
|
||
|
||
Link directly to Isotope files on [npmcdn](https://npmcdn.com).
|
||
|
||
``` html
|
||
<script src="https://npmcdn.com/isotope-layout@3.0/dist/isotope.pkgd.min.js"></script>
|
||
<!-- or -->
|
||
<script src="https://npmcdn.com/isotope-layout@3.0/dist/isotope.pkgd.js"></script>
|
||
```
|
||
|
||
### Package managers
|
||
|
||
npm: `npm install isotope-layout --save`
|
||
|
||
Bower: `bower install isotope --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](http://isotope.metafizzy.co/#commercial-license)
|
||
|
||
### Open source license
|
||
|
||
If you are creating an open source application under a license compatible with the [GNU GPL license v3](https://www.gnu.org/licenses/gpl-3.0.html), you may use Isotope under the terms of the GPLv3.
|
||
|
||
[Read more about Isotope's license](http://isotope.metafizzy.co/license.html).
|
||
|
||
## Initialize
|
||
|
||
With jQuery
|
||
|
||
``` js
|
||
$('.grid').isotope({
|
||
// options...
|
||
itemSelector: '.grid-item',
|
||
masonry: {
|
||
columnWidth: 200
|
||
}
|
||
});
|
||
```
|
||
|
||
With vanilla JavaScript
|
||
|
||
``` js
|
||
// 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.
|
||
|
||
``` html
|
||
<div class="grid"
|
||
data-isotope='{ "itemSelector": ".grid-item", "masonry": { "columnWidth": 200 } }'>
|
||
<div class="grid-item"></div>
|
||
<div class="grid-item"></div>
|
||
...
|
||
</div>
|
||
```
|
||
|
||
* * *
|
||
|
||
By [Metafizzy](http://metafizzy.co), 2010–2016
|