Home Explore Help
Sign In
bachir
/
popsu-d7
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: 870831757c
Branches Tags
popsu-d7
/
sites
/
all
/
libraries
/
isotope-site
/
docs
/
introduction.html

introduction.html 17 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325 
  1. <!doctype html>
    2. 

  2. <html lang="en">
    3. 

  3. <head>
    4. 

  4.   
    5. 

  5.   <meta charset="utf-8" />
    6. 

  6.   <title>Introduction &middot; Isotope Docs</title>
    7. 

  7.   
    8. 

  8.   <!--[if lt IE 9]><script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
    9. 

  9.   
    10. 

  10.   <link rel="stylesheet" href="../css/style.css" />
    11. 

  11.   
    12. 

  12.   <!-- scripts at bottom of page -->
    13. 

  13. 

  14. </head>
    15. 

  15. <body class="docs ">
    16. 

  16.   
    17. 

  17.   <nav id="site-nav">
    18. 

  18.     <h1><a href="../index.html">Isotope</a></h1>
    19. 

  19. 

  20.     <h2>Docs</h2>
    21. 

  21.     
    22. 

  22.     <ul>
    23. 

  23.       
    24. 

  24.         
    25. 

  25.         <li class="current"><a href="#content">Introduction</a>
    26. 

  26.           <ul class="toc">
    27. 

  27.             
    28. 

  28.               <li><a href="#features">Features</a></li>
    29. 

  29.             
    30. 

  30.               <li><a href="#licensing">Licensing</a></li>
    31. 

  31.             
    32. 

  32.               <li><a href="#getting_started">Getting started</a></li>
    33. 

  33.             
    34. 

  34.               <li><a href="#code_repository">Code repository</a></li>
    35. 

  35.             
    36. 

  36.               <li><a href="#moderation">A word about moderation</a></li>
    37. 

  37.             
    38. 

  38.               <li><a href="#acknowledgments">Acknowledgments</a></li>
    39. 

  39.             
    40. 

  40.           </ul>
    41. 

  41.         </li>
    42. 

  42.         
    43. 

  43.       
    44. 

  44.         
    45. 

  45.           <li><a href="../docs/options.html">Options</a>
    46. 

  46.         
    47. 

  47.       
    48. 

  48.         
    49. 

  49.           <li><a href="../docs/methods.html">Methods</a>
    50. 

  50.         
    51. 

  51.       
    52. 

  52.         
    53. 

  53.           <li><a href="../docs/layout-modes.html">Layout modes</a>
    54. 

  54.         
    55. 

  55.       
    56. 

  56.         
    57. 

  57.           <li><a href="../docs/filtering.html">Filtering</a>
    58. 

  58.         
    59. 

  59.       
    60. 

  60.         
    61. 

  61.           <li><a href="../docs/sorting.html">Sorting</a>
    62. 

  62.         
    63. 

  63.       
    64. 

  64.         
    65. 

  65.           <li><a href="../docs/animating.html">Animating</a>
    66. 

  66.         
    67. 

  67.       
    68. 

  68.         
    69. 

  69.           <li><a href="../docs/adding-items.html">Adding items</a>
    70. 

  70.         
    71. 

  71.       
    72. 

  72.         
    73. 

  73.           <li><a href="../docs/extending-isotope.html">Extending Isotope</a>
    74. 

  74.         
    75. 

  75.       
    76. 

  76.         
    77. 

  77.           <li><a href="../docs/hash-history-jquery-bbq.html">Hash history with jQuery BBQ</a>
    78. 

  78.         
    79. 

  79.       
    80. 

  80.         
    81. 

  81.           <li><a href="../docs/help.html">Help</a>
    82. 

  82.         
    83. 

  83.       
    84. 

  84.         
    85. 

  85.           <li><a href="../docs/license.html">License</a>
    86. 

  86.         
    87. 

  87.       
    88. 

  88.     </ul>
    89. 

  89.     
    90. 

  90.     <h2>Demos</h2>
    91. 

  91.     
    92. 

  92.     <ul>
    93. 

  93.       
    94. 

  94.         
    95. 

  95.           <li><a href="../demos/basic.html">Basic</a>
    96. 

  96.         
    97. 

  97.       
    98. 

  98.         
    99. 

  99.           <li><a href="../demos/elements-complete.html">Elements Complete</a>
    100. 

  100.         
    101. 

  101.       
    102. 

  102.         
    103. 

  103.           <li><a href="../demos/elements-partial.html">Elements Partial</a>
    104. 

  104.         
    105. 

  105.       
    106. 

  106.         
    107. 

  107.           <li><a href="../demos/layout-modes.html">Layout modes</a>
    108. 

  108.         
    109. 

  109.       
    110. 

  110.         
    111. 

  111.           <li><a href="../demos/filtering.html">Filtering</a>
    112. 

  112.         
    113. 

  113.       
    114. 

  114.         
    115. 

  115.           <li><a href="../demos/sorting.html">Sorting</a>
    116. 

  116.         
    117. 

  117.       
    118. 

  118.         
    119. 

  119.           <li><a href="../demos/relayout.html">reLayout</a>
    120. 

  120.         
    121. 

  121.       
    122. 

  122.         
    123. 

  123.           <li><a href="../demos/adding-items.html">Adding items</a>
    124. 

  124.         
    125. 

  125.       
    126. 

  126.         
    127. 

  127.           <li><a href="../demos/infinite-scroll.html">Infinite Scroll</a>
    128. 

  128.         
    129. 

  129.       
    130. 

  130.         
    131. 

  131.           <li><a href="../demos/images.html">Images</a>
    132. 

  132.         
    133. 

  133.       
    134. 

  134.         
    135. 

  135.           <li><a href="../demos/combination-filters.html">Combination filters</a>
    136. 

  136.         
    137. 

  137.       
    138. 

  138.         
    139. 

  139.           <li><a href="../demos/hash-history.html">Hash history</a>
    140. 

  140.         
    141. 

  141.       
    142. 

  142.         
    143. 

  143.           <li><a href="../demos/fluid-responsive.html">Fluid / responsive</a>
    144. 

  144.         
    145. 

  145.       
    146. 

  146.     </ul>
    147. 

  147.     
    148. 

  148.     <h2>Custom layout modes</h2>
    149. 

  149.     
    150. 

  150.     <ul>
    151. 

  151.       
    152. 

  152.         
    153. 

  153.           <li><a href="../custom-layout-modes/centered-masonry.html">Centered Masonry</a>
    154. 

  154.         
    155. 

  155.       
    156. 

  156.         
    157. 

  157.           <li><a href="../custom-layout-modes/category-rows.html">Category rows</a>
    158. 

  158.         
    159. 

  159.       
    160. 

  160.         
    161. 

  161.           <li><a href="../custom-layout-modes/masonry-corner-stamp.html">Masonry corner stamp</a>
    162. 

  162.         
    163. 

  163.       
    164. 

  164.         
    165. 

  165.           <li><a href="../custom-layout-modes/masonry-gutters.html">Masonry gutters</a>
    166. 

  166.         
    167. 

  167.       
    168. 

  168.         
    169. 

  169.           <li><a href="../custom-layout-modes/spine-align.html">Spine align</a>
    170. 

  170.         
    171. 

  171.       
    172. 

  172.     </ul>
    173. 

  173.     
    174. 

  174.     <h2><a href="../tests/index.html">Tests</a></h2>
    175. 

  175.     
    176. 

  176.   </nav> <!-- #site-nav -->
    177. 

  177.   
    178. 

  178.   <section id="content">
    179. 

  179.     
    180. 

  180.       <h1>Introduction</h1>
    181. 

  181.     
    182. 

  182. 

  183.     <p class='tagline'>Isotope: An exquisite jQuery plugin for magical layouts</p>
    184. 

  184. <h2 id='features'>Features</h2>
    185. 

  185. 

  186. <ul>
    187. 

  187. <li><a href='layout-modes.html'><strong>Layout modes</strong></a>: Intelligent, dynamic layouts that can&#8217;t be achieved with CSS alone.</li>
    188. 

  188. 

  189. <li><a href='filtering.html'><strong>Filtering</strong></a>: Hide and reveal item elements easily with jQuery selectors.</li>
    190. 

  190. 

  191. <li><a href='sorting.html'><strong>Sorting</strong></a>: Re-order item elements with sorting. Sorting data can be extracted from just about anything.</li>
    192. 

  192. 

  193. <li><strong>Interoperability</strong>: features can be utilized together for a cohesive experience.</li>
    194. 

  194. 

  195. <li><strong>Progressive enhancement</strong>: Isotope&#8217;s <a href='animating.html'>animation engine</a> takes advantage of the best browser features when available &#8212; CSS transitions and transforms, GPU acceleration &#8212; but will also fall back to JavaScript animation for lesser browsers.</li>
    196. 

  196. </ul>
    197. 

  197. 

  198. <h2 id='licensing'>Licensing</h2>
    199. 

  199. <p id='commercial'>
    200. 

  200.   <strong>Commercial use of Isotope requires purchase of one-time license fee per developer seat.</strong> Commercial use includes any application that makes you money &mdash; portfolio sites, premium templates, etc. Commercial licenses may be purchased at <a href='http://metafizzy.co/#isotope-license'>metafizzy.co</a>.
    201. 

  201. </p>
    202. 

  202. <p>Use in non-commercial and personal applications is free.</p>
    203. 

  203. 

  204. <h2 id='getting_started'>Getting started</h2>
    205. 

  205. 

  206. <p>Isotope requires jQuery 1.4.3 and greater.</p>
    207. 

  207. 

  208. <h3 id='markup'>Markup</h3>
    209. 

  209. 

  210. <p>Isotope works on a container element with a group of similar child items.</p>
    211. 

  211. <div class='highlight'><pre><code class='html'><span class='nt'>&lt;div</span> <span class='na'>id=</span><span class='s'>&quot;container&quot;</span><span class='nt'>&gt;</span>
    212. 

  212.   <span class='nt'>&lt;div</span> <span class='na'>class=</span><span class='s'>&quot;item&quot;</span><span class='nt'>&gt;</span>...<span class='nt'>&lt;/div&gt;</span>
    213. 

  213.   <span class='nt'>&lt;div</span> <span class='na'>class=</span><span class='s'>&quot;item&quot;</span><span class='nt'>&gt;</span>...<span class='nt'>&lt;/div&gt;</span>
    214. 

  214.   <span class='nt'>&lt;div</span> <span class='na'>class=</span><span class='s'>&quot;item&quot;</span><span class='nt'>&gt;</span>...<span class='nt'>&lt;/div&gt;</span>
    215. 

  215.   ...
    216. 

  216. <span class='nt'>&lt;/div&gt;</span>
    217. 

  217. </code></pre>
    218. 

  218. </div>
    219. 

  219. <h3 id='script'>Script</h3>
    220. 

  220. <div class='highlight'><pre><code class='javascript'><span class='nx'>$</span><span class='p'>(</span><span class='s1'>&#39;#container&#39;</span><span class='p'>).</span><span class='nx'>isotope</span><span class='p'>({</span>
    221. 

  221.   <span class='c1'>// options</span>
    222. 

  222.   <span class='nx'>itemSelector</span> <span class='o'>:</span> <span class='s1'>&#39;.item&#39;</span><span class='p'>,</span>
    223. 

  223.   <span class='nx'>layoutMode</span> <span class='o'>:</span> <span class='s1'>&#39;fitRows&#39;</span>
    224. 

  224. <span class='p'>});</span>
    225. 

  225. </code></pre>
    226. 

  226. </div>
    227. 

  227. <p><a href='../demos/basic.html'><strong>See Demo: Basic</strong></a></p>
    228. 

  228. 

  229. <p>There are a number of <a href='options.html'>options</a> you can specify. Within the options is where you can <a href='layout-modes.html'>set the layout mode</a>, <a href='filtering.html'>filter items</a>, and <a href='sorting.html'>sort items</a>.</p>
    230. 

  230. 

  231. <p>Additionally you can specify a callback after the options object. This function will be triggered after the animation has completed.</p>
    232. 

  232. <div class='highlight'><pre><code class='javascript'><span class='nx'>$</span><span class='p'>(</span><span class='s1'>&#39;#container&#39;</span><span class='p'>).</span><span class='nx'>isotope</span><span class='p'>({</span> <span class='nx'>filter</span><span class='o'>:</span> <span class='s1'>&#39;.my-selector&#39;</span> <span class='p'>},</span> <span class='kd'>function</span><span class='p'>(</span> <span class='nx'>$items</span> <span class='p'>)</span> <span class='p'>{</span>
    233. 

  233.   <span class='kd'>var</span> <span class='nx'>id</span> <span class='o'>=</span> <span class='k'>this</span><span class='p'>.</span><span class='nx'>attr</span><span class='p'>(</span><span class='s1'>&#39;id&#39;</span><span class='p'>),</span>
    234. 

  234.       <span class='nx'>len</span> <span class='o'>=</span> <span class='nx'>$items</span><span class='p'>.</span><span class='nx'>length</span><span class='p'>;</span>
    235. 

  235.   <span class='nx'>console</span><span class='p'>.</span><span class='nx'>log</span><span class='p'>(</span> <span class='s1'>&#39;Isotope has filtered for &#39;</span> <span class='o'>+</span> <span class='nx'>len</span> <span class='o'>+</span> <span class='s1'>&#39; items in #&#39;</span> <span class='o'>+</span> <span class='nx'>id</span> <span class='p'>);</span>
    236. 

  236. <span class='p'>});</span>
    237. 

  237. </code></pre>
    238. 

  238. </div>
    239. 

  239. <p>Within this callback <code><span class='k'>this</span></code> refers to the container, and <code>$items</code> refers to the item elements. Both of these are jQuery objects and do <em>not</em> need to be put in jQuery wrappers.</p>
    240. 

  240. 

  241. <h3 id='css'>CSS</h3>
    242. 

  242. 

  243. <p>Add these styles to your CSS for <a href='filtering.html'>filtering</a>, <a href='animating.html'>animation</a> with CSS transitions, and <a href='adding-items.html'>adding items</a>.</p>
    244. 

  244. <div class='highlight'><pre><code class='css'><span class='c'>/**** Isotope Filtering ****/</span>
    245. 

  245. 

  246. <span class='nc'>.isotope-item</span> <span class='p'>{</span>
    247. 

  247.   <span class='k'>z-index</span><span class='o'>:</span> <span class='m'>2</span><span class='p'>;</span>
    248. 

  248. <span class='p'>}</span>
    249. 

  249. 

  250. <span class='nc'>.isotope-hidden.isotope-item</span> <span class='p'>{</span>
    251. 

  251.   <span class='k'>pointer</span><span class='o'>-</span><span class='n'>events</span><span class='o'>:</span> <span class='k'>none</span><span class='p'>;</span>
    252. 

  252.   <span class='k'>z-index</span><span class='o'>:</span> <span class='m'>1</span><span class='p'>;</span>
    253. 

  253. <span class='p'>}</span>
    254. 

  254. 

  255. <span class='c'>/**** Isotope CSS3 transitions ****/</span>
    256. 

  256. 

  257. <span class='nc'>.isotope</span><span class='o'>,</span>
    258. 

  258. <span class='nc'>.isotope</span> <span class='nc'>.isotope-item</span> <span class='p'>{</span>
    259. 

  259.   <span class='o'>-</span><span class='n'>webkit</span><span class='o'>-</span><span class='n'>transition</span><span class='o'>-</span><span class='n'>duration</span><span class='o'>:</span> <span class='m'>0.8s</span><span class='p'>;</span>
    260. 

  260.      <span class='o'>-</span><span class='n'>moz</span><span class='o'>-</span><span class='n'>transition</span><span class='o'>-</span><span class='n'>duration</span><span class='o'>:</span> <span class='m'>0.8s</span><span class='p'>;</span>
    261. 

  261.           <span class='n'>transition</span><span class='o'>-</span><span class='n'>duration</span><span class='o'>:</span> <span class='m'>0.8s</span><span class='p'>;</span>
    262. 

  262. <span class='p'>}</span>
    263. 

  263. 

  264. <span class='nc'>.isotope</span> <span class='p'>{</span>
    265. 

  265.   <span class='o'>-</span><span class='n'>webkit</span><span class='o'>-</span><span class='n'>transition</span><span class='o'>-</span><span class='n'>property</span><span class='o'>:</span> <span class='k'>height</span><span class='o'>,</span> <span class='k'>width</span><span class='p'>;</span>
    266. 

  266.      <span class='o'>-</span><span class='n'>moz</span><span class='o'>-</span><span class='n'>transition</span><span class='o'>-</span><span class='n'>property</span><span class='o'>:</span> <span class='k'>height</span><span class='o'>,</span> <span class='k'>width</span><span class='p'>;</span>
    267. 

  267.           <span class='n'>transition</span><span class='o'>-</span><span class='n'>property</span><span class='o'>:</span> <span class='k'>height</span><span class='o'>,</span> <span class='k'>width</span><span class='p'>;</span>
    268. 

  268. <span class='p'>}</span>
    269. 

  269. 

  270. <span class='nc'>.isotope</span> <span class='nc'>.isotope-item</span> <span class='p'>{</span>
    271. 

  271.   <span class='o'>-</span><span class='n'>webkit</span><span class='o'>-</span><span class='n'>transition</span><span class='o'>-</span><span class='n'>property</span><span class='o'>:</span> <span class='o'>-</span><span class='n'>webkit</span><span class='o'>-</span><span class='n'>transform</span><span class='o'>,</span> <span class='k'>opacity</span><span class='p'>;</span>
    272. 

  272.      <span class='o'>-</span><span class='n'>moz</span><span class='o'>-</span><span class='n'>transition</span><span class='o'>-</span><span class='n'>property</span><span class='o'>:</span>    <span class='o'>-</span><span class='n'>moz</span><span class='o'>-</span><span class='n'>transform</span><span class='o'>,</span> <span class='k'>opacity</span><span class='p'>;</span>
    273. 

  273.           <span class='n'>transition</span><span class='o'>-</span><span class='n'>property</span><span class='o'>:</span>         <span class='n'>transform</span><span class='o'>,</span> <span class='k'>opacity</span><span class='p'>;</span>
    274. 

  274. <span class='p'>}</span>
    275. 

  275. 

  276. <span class='c'>/**** disabling Isotope CSS3 transitions ****/</span>
    277. 

  277. 

  278. <span class='nc'>.isotope.no-transition</span><span class='o'>,</span>
    279. 

  279. <span class='nc'>.isotope.no-transition</span> <span class='nc'>.isotope-item</span><span class='o'>,</span>
    280. 

  280. <span class='nc'>.isotope</span> <span class='nc'>.isotope-item.no-transition</span> <span class='p'>{</span>
    281. 

  281.   <span class='o'>-</span><span class='n'>webkit</span><span class='o'>-</span><span class='n'>transition</span><span class='o'>-</span><span class='n'>duration</span><span class='o'>:</span> <span class='m'>0s</span><span class='p'>;</span>
    282. 

  282.      <span class='o'>-</span><span class='n'>moz</span><span class='o'>-</span><span class='n'>transition</span><span class='o'>-</span><span class='n'>duration</span><span class='o'>:</span> <span class='m'>0s</span><span class='p'>;</span>
    283. 

  283.           <span class='n'>transition</span><span class='o'>-</span><span class='n'>duration</span><span class='o'>:</span> <span class='m'>0s</span><span class='p'>;</span>
    284. 

  284. <span class='p'>}</span>
    285. 

  285. </code></pre>
    286. 

  286. </div>
    287. 

  287. <h2 id='code_repository'>Code repository</h2>
    288. 

  288. 

  289. <p>This project lives on GitHub at <a href='http://github.com/desandro/isotope'>github.com/desandro/isotope</a>. There you can grab the latest code and follow development.</p>
    290. 

  290. 

  291. <h2 id='moderation'>A word about moderation</h2>
    292. 

  292. 

  293. <p>Isotope enables a wealth of functionality. But just because you can take advantage of its numerous features together, doesn&#8217;t mean you necessarily should. For each each feature you implement with Isotope, consider the benefit gained by users, at the cost of another level of complexity to your interface.</p>
    294. 

  294. 

  295. <h2 id='acknowledgments'>Acknowledgments</h2>
    296. 

  296. 

  297. <ul>
    298. 

  298. <li><a href='http://benalman.com/'><strong>&#8220;Cowboy&#8221; Ben Alman</strong></a> for <a href='http://benalman.com/projects/jquery-bbq-plugin/'>jQuery BBQ</a> (included with docs)</li>
    299. 

  299. 

  300. <li><a href='http://twitter.com/Louis_Remi'><strong>Louis-Rémi Babé</strong></a> for <a href='https://github.com/louisremi/jquery-smartresize'>jQuery smartresize</a> (used within Isotope) and for <a href='https://github.com/louisremi/jquery.transform.js'>jQuery transform</a> which clued me in to using jQuery 1.4.3&#8217;s CSS hooks</li>
    301. 

  301. 

  302. <li><a href='http://razorjack.net/'><strong>Jacek Galanciak</strong></a> for <a href='http://razorjack.net/quicksand/'>jQuery Quicksand</a>, an early kernel of inspiration</li>
    303. 

  303. 

  304. <li><a href='http://twitter.com/#!/ralphholzmann'><strong>Ralph Holzmann</strong></a> for re-writing the <a href='http://docs.jquery.com/Plugins/Authoring'>jQuery Plugins/Authoring tutorial</a> and opened my eyes to <a href='http://docs.jquery.com/Plugins/Authoring#Plugin_Methods'>Plugin Methods</a> pattern</li>
    305. 

  305. 

  306. <li><a href='http://www.erichynds.com/'><strong>Eric Hynds</strong></a> for his article <a href='http://www.erichynds.com/jquery/using-jquery-ui-widget-factory-bridge/'>Using $.widget.bridge Outside of the Widget Factory</a> which provided the architecture for Isotope</li>
    307. 

  307. 

  308. <li><a href='http://paul-irish.com'><strong>Paul Irish</strong></a> for <a href='http://infinite-scroll.com'>Infinite Scroll</a> (included with docs), the <a href='http://gist.github.com/268257'>imagesLoaded plugin</a> (included with Isotope), and <a href='http://paulirish.com/demo/resize'>Debounced resize() plugin</a> (provided base for smartresize)</li>
    309. 

  309. 

  310. <li>The <a href='http://jqueryui.com/about'><strong>jQuery UI Team</strong></a> for <a href='https://github.com/jquery/jquery-ui/blob/master/ui/jquery.ui.widget.js#L113-155'>$.widget.bridge</a> (partially used within Isotope)</li>
    311. 

  311. 

  312. <li>The Modernizr team for <a href='http://www.modernizr.com/'>Modernizr</a> (partially used within Isotope)</li>
    313. 

  313. 

  314. <li><a href='http://perfectionkills.com'><strong>Juriy Zaytsev aka &#8220;kangax&#8221;</strong></a> for <a href='http://perfectionkills.com/feature-testing-css-properties/'>getStyleProperty</a> (used within Isotope)</li>
    315. 

  315. </ul>
    316. 

  316.     
    317. 

  317.     <footer>
    318. 

  318.       Isotope by <a href="http://desandro.com">David DeSandro</a> / <a href="http://metafizzy.co">Metafizzy</a>
    319. 

  319.     </footer>
    320. 

  320.     
    321. 

  321.   </section> <!-- #content -->
    322. 

  322.   
    323. 

  323. 

  324. </body>
    325. 

  325. </html>
    326.