123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268 |
- <!doctype html>
- <html lang="en">
- <head>
-
- <meta charset="utf-8" />
- <title>Filtering · Isotope Docs</title>
-
- <!--[if lt IE 9]><script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
-
- <link rel="stylesheet" href="../css/style.css" />
-
- <!-- scripts at bottom of page -->
- </head>
- <body class="docs ">
-
- <nav id="site-nav">
- <h1><a href="../index.html">Isotope</a></h1>
- <h2>Docs</h2>
-
- <ul>
-
-
- <li><a href="../docs/introduction.html">Introduction</a>
-
-
-
- <li><a href="../docs/options.html">Options</a>
-
-
-
- <li><a href="../docs/methods.html">Methods</a>
-
-
-
- <li><a href="../docs/layout-modes.html">Layout modes</a>
-
-
-
- <li class="current"><a href="#content">Filtering</a>
- <ul class="toc">
-
- <li><a href="#markup">Markup</a></li>
-
- <li><a href="#jquery_script">jQuery script</a></li>
-
- <li><a href="#creating_interactive_buttons">Creating interactive buttons</a></li>
-
- <li><a href="#recommended_css">Recommended CSS</a></li>
-
- </ul>
- </li>
-
-
-
- <li><a href="../docs/sorting.html">Sorting</a>
-
-
-
- <li><a href="../docs/animating.html">Animating</a>
-
-
-
- <li><a href="../docs/adding-items.html">Adding items</a>
-
-
-
- <li><a href="../docs/extending-isotope.html">Extending Isotope</a>
-
-
-
- <li><a href="../docs/hash-history-jquery-bbq.html">Hash history with jQuery BBQ</a>
-
-
-
- <li><a href="../docs/help.html">Help</a>
-
-
-
- <li><a href="../docs/license.html">License</a>
-
-
- </ul>
-
- <h2>Demos</h2>
-
- <ul>
-
-
- <li><a href="../demos/basic.html">Basic</a>
-
-
-
- <li><a href="../demos/elements-complete.html">Elements Complete</a>
-
-
-
- <li><a href="../demos/elements-partial.html">Elements Partial</a>
-
-
-
- <li><a href="../demos/layout-modes.html">Layout modes</a>
-
-
-
- <li><a href="../demos/filtering.html">Filtering</a>
-
-
-
- <li><a href="../demos/sorting.html">Sorting</a>
-
-
-
- <li><a href="../demos/relayout.html">reLayout</a>
-
-
-
- <li><a href="../demos/adding-items.html">Adding items</a>
-
-
-
- <li><a href="../demos/infinite-scroll.html">Infinite Scroll</a>
-
-
-
- <li><a href="../demos/images.html">Images</a>
-
-
-
- <li><a href="../demos/combination-filters.html">Combination filters</a>
-
-
-
- <li><a href="../demos/hash-history.html">Hash history</a>
-
-
-
- <li><a href="../demos/fluid-responsive.html">Fluid / responsive</a>
-
-
- </ul>
-
- <h2>Custom layout modes</h2>
-
- <ul>
-
-
- <li><a href="../custom-layout-modes/centered-masonry.html">Centered Masonry</a>
-
-
-
- <li><a href="../custom-layout-modes/category-rows.html">Category rows</a>
-
-
-
- <li><a href="../custom-layout-modes/masonry-corner-stamp.html">Masonry corner stamp</a>
-
-
-
- <li><a href="../custom-layout-modes/masonry-gutters.html">Masonry gutters</a>
-
-
-
- <li><a href="../custom-layout-modes/spine-align.html">Spine align</a>
-
-
- </ul>
-
- <h2><a href="../tests/index.html">Tests</a></h2>
-
- </nav> <!-- #site-nav -->
-
- <section id="content">
-
- <h1>Filtering</h1>
-
- <p>Isotope can hide and show item elements via the <a href='options.html#filter'><code>filter</code> option</a>. <code>filter</code> accepts a jQuery selector. Items that match that selector will be shown. Items that do not match will be hidden.</p>
- <p><a href='../demos/filtering.html'><strong>See Demo: Filtering</strong></a></p>
- <h2 id='markup'>Markup</h2>
- <p>Each item element has several identifying classes. In this case, <code>transition</code>, <code>metal</code>, <code>lanthanoid</code>, <code>alkali</code>, etc.</p>
- <div class='highlight'><pre><code class='html'><span class='nt'><div</span> <span class='na'>id=</span><span class='s'>"container"</span><span class='nt'>></span>
- <span class='nt'><div</span> <span class='na'>class=</span><span class='s'>"element transition metal"</span><span class='nt'>></span>...<span class='nt'></div></span>
- <span class='nt'><div</span> <span class='na'>class=</span><span class='s'>"element post-transition metal"</span><span class='nt'>></span>...<span class='nt'></div></span>
- <span class='nt'><div</span> <span class='na'>class=</span><span class='s'>"element alkali metal"</span><span class='nt'>></span>...<span class='nt'></div></span>
- <span class='nt'><div</span> <span class='na'>class=</span><span class='s'>"element transition metal"</span><span class='nt'>></span>...<span class='nt'></div></span>
- <span class='nt'><div</span> <span class='na'>class=</span><span class='s'>"element lanthanoid metal inner-transition"</span><span class='nt'>></span>...<span class='nt'></div></span>
- <span class='nt'><div</span> <span class='na'>class=</span><span class='s'>"element halogen nonmetal"</span><span class='nt'>></span>...<span class='nt'></div></span>
- <span class='nt'><div</span> <span class='na'>class=</span><span class='s'>"element alkaline-earth metal"</span><span class='nt'>></span>...<span class='nt'></div></span>
- ...
- <span class='nt'></div></span>
- </code></pre>
- </div>
- <h2 id='jquery_script'>jQuery script</h2>
- <p>To show only <code>.metal</code> items, the jQuery script would be:</p>
- <div class='highlight'><pre><code class='javascript'><span class='nx'>$</span><span class='p'>(</span><span class='s1'>'#container'</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'>'.metal'</span> <span class='p'>});</span>
- </code></pre>
- </div>
- <p>The <code>filter</code> option uses a <a href='http://api.jquery.com/category/selectors/'>jQuery selector</a> to show item elements that match a selector, and hide all others that do not. For example:</p>
- <ul>
- <li><code>.alkali, .alkaline-earth</code> will show <code>.alkali</code> AND <code> .alkaline-earth</code> item elements.</li>
- <li><code>.metal.transition</code> will show item elements that have BOTH <code>.metal</code> and <code>.transition</code> classes.</li>
- <li><code>.metal:not(.transition)</code> will show <code>.metal</code> item elements that are NOT <code>.transition</code>.</li>
- </ul>
- <h2 id='creating_interactive_buttons'>Creating interactive buttons</h2>
- <p>Let’s use a basic list for our buttons</p>
- <div class='highlight'><pre><code class='html'><span class='nt'><ul</span> <span class='na'>id=</span><span class='s'>"filters"</span><span class='nt'>></span>
- <span class='nt'><li><a</span> <span class='na'>href=</span><span class='s'>"#"</span> <span class='na'>data-filter=</span><span class='s'>"*"</span><span class='nt'>></span>show all<span class='nt'></a></li></span>
- <span class='nt'><li><a</span> <span class='na'>href=</span><span class='s'>"#"</span> <span class='na'>data-filter=</span><span class='s'>".metal"</span><span class='nt'>></span>metal<span class='nt'></a></li></span>
- <span class='nt'><li><a</span> <span class='na'>href=</span><span class='s'>"#"</span> <span class='na'>data-filter=</span><span class='s'>".transition"</span><span class='nt'>></span>transition<span class='nt'></a></li></span>
- <span class='nt'><li><a</span> <span class='na'>href=</span><span class='s'>"#"</span> <span class='na'>data-filter=</span><span class='s'>".alkali, .alkaline-earth"</span><span class='nt'>></span>alkali and alkaline-earth<span class='nt'></a></li></span>
- <span class='nt'><li><a</span> <span class='na'>href=</span><span class='s'>"#"</span> <span class='na'>data-filter=</span><span class='s'>":not(.transition)"</span><span class='nt'>></span>not transition<span class='nt'></a></li></span>
- <span class='nt'><li><a</span> <span class='na'>href=</span><span class='s'>"#"</span> <span class='na'>data-filter=</span><span class='s'>".metal:not(.transition)"</span><span class='nt'>></span>metal but not transition<span class='nt'></a></li></span>
- <span class='nt'></ul></span>
- </code></pre>
- </div>
- <p>Here we set the filter for each link with a <code>data-filter</code> attribute. In our jQuery script, whenever a link is clicked, we’ll use this attribute as the filter selector.</p>
- <div class='highlight'><pre><code class='javascript'><span class='c1'>// cache container</span>
- <span class='kd'>var</span> <span class='nx'>$container</span> <span class='o'>=</span> <span class='nx'>$</span><span class='p'>(</span><span class='s1'>'#container'</span><span class='p'>);</span>
- <span class='c1'>// initialize isotope</span>
- <span class='nx'>$container</span><span class='p'>.</span><span class='nx'>isotope</span><span class='p'>({</span>
- <span class='c1'>// options...</span>
- <span class='p'>});</span>
- <span class='c1'>// filter items when filter link is clicked</span>
- <span class='nx'>$</span><span class='p'>(</span><span class='s1'>'#filters a'</span><span class='p'>).</span><span class='nx'>click</span><span class='p'>(</span><span class='kd'>function</span><span class='p'>(){</span>
- <span class='kd'>var</span> <span class='nx'>selector</span> <span class='o'>=</span> <span class='nx'>$</span><span class='p'>(</span><span class='k'>this</span><span class='p'>).</span><span class='nx'>attr</span><span class='p'>(</span><span class='s1'>'data-filter'</span><span class='p'>);</span>
- <span class='nx'>$container</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='nx'>selector</span> <span class='p'>});</span>
- <span class='k'>return</span> <span class='kc'>false</span><span class='p'>;</span>
- <span class='p'>});</span>
- </code></pre>
- </div>
- <h2 id='recommended_css'>Recommended CSS</h2>
- <p>If you choose to use the filtering functionality, add the following CSS to your stylesheet:</p>
- <div class='highlight'><pre><code class='css'><span class='c'>/**** Isotope filtering ****/</span>
- <span class='nc'>.isotope-item</span> <span class='p'>{</span>
- <span class='k'>z-index</span><span class='o'>:</span> <span class='m'>2</span><span class='p'>;</span>
- <span class='p'>}</span>
- <span class='nc'>.isotope-hidden.isotope-item</span> <span class='p'>{</span>
- <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>
- <span class='k'>z-index</span><span class='o'>:</span> <span class='m'>1</span><span class='p'>;</span>
- <span class='p'>}</span>
- </code></pre>
- </div>
- <p>These styles ensure that hidden items will not interfere with interactions.</p>
-
- <footer>
- Isotope by <a href="http://desandro.com">David DeSandro</a> / <a href="http://metafizzy.co">Metafizzy</a>
- </footer>
-
- </section> <!-- #content -->
-
- </body>
- </html>
|