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
/
hash-history-jquery-bbq.html

hash-history-jquery-bbq.html 12 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245 
  1. <!doctype html>
    2. 

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

  3. <head>
    4. 

  4.   
    5. 

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

  6.   <title>Hash history with jQuery BBQ &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><a href="../docs/introduction.html">Introduction</a>
    26. 

  26.         
    27. 

  27.       
    28. 

  28.         
    29. 

  29.           <li><a href="../docs/options.html">Options</a>
    30. 

  30.         
    31. 

  31.       
    32. 

  32.         
    33. 

  33.           <li><a href="../docs/methods.html">Methods</a>
    34. 

  34.         
    35. 

  35.       
    36. 

  36.         
    37. 

  37.           <li><a href="../docs/layout-modes.html">Layout modes</a>
    38. 

  38.         
    39. 

  39.       
    40. 

  40.         
    41. 

  41.           <li><a href="../docs/filtering.html">Filtering</a>
    42. 

  42.         
    43. 

  43.       
    44. 

  44.         
    45. 

  45.           <li><a href="../docs/sorting.html">Sorting</a>
    46. 

  46.         
    47. 

  47.       
    48. 

  48.         
    49. 

  49.           <li><a href="../docs/animating.html">Animating</a>
    50. 

  50.         
    51. 

  51.       
    52. 

  52.         
    53. 

  53.           <li><a href="../docs/adding-items.html">Adding items</a>
    54. 

  54.         
    55. 

  55.       
    56. 

  56.         
    57. 

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

  58.         
    59. 

  59.       
    60. 

  60.         
    61. 

  61.         <li class="current"><a href="#content">Hash history with jQuery BBQ</a>
    62. 

  62.           <ul class="toc">
    63. 

  63.             
    64. 

  64.               <li><a href="#markup">Markup</a></li>
    65. 

  65.             
    66. 

  66.               <li><a href="#jquery_script">jQuery script</a></li>
    67. 

  67.             
    68. 

  68.           </ul>
    69. 

  69.         </li>
    70. 

  70.         
    71. 

  71.       
    72. 

  72.         
    73. 

  73.           <li><a href="../docs/help.html">Help</a>
    74. 

  74.         
    75. 

  75.       
    76. 

  76.         
    77. 

  77.           <li><a href="../docs/license.html">License</a>
    78. 

  78.         
    79. 

  79.       
    80. 

  80.     </ul>
    81. 

  81.     
    82. 

  82.     <h2>Demos</h2>
    83. 

  83.     
    84. 

  84.     <ul>
    85. 

  85.       
    86. 

  86.         
    87. 

  87.           <li><a href="../demos/basic.html">Basic</a>
    88. 

  88.         
    89. 

  89.       
    90. 

  90.         
    91. 

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

  92.         
    93. 

  93.       
    94. 

  94.         
    95. 

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

  96.         
    97. 

  97.       
    98. 

  98.         
    99. 

  99.           <li><a href="../demos/layout-modes.html">Layout modes</a>
    100. 

  100.         
    101. 

  101.       
    102. 

  102.         
    103. 

  103.           <li><a href="../demos/filtering.html">Filtering</a>
    104. 

  104.         
    105. 

  105.       
    106. 

  106.         
    107. 

  107.           <li><a href="../demos/sorting.html">Sorting</a>
    108. 

  108.         
    109. 

  109.       
    110. 

  110.         
    111. 

  111.           <li><a href="../demos/relayout.html">reLayout</a>
    112. 

  112.         
    113. 

  113.       
    114. 

  114.         
    115. 

  115.           <li><a href="../demos/adding-items.html">Adding items</a>
    116. 

  116.         
    117. 

  117.       
    118. 

  118.         
    119. 

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

  120.         
    121. 

  121.       
    122. 

  122.         
    123. 

  123.           <li><a href="../demos/images.html">Images</a>
    124. 

  124.         
    125. 

  125.       
    126. 

  126.         
    127. 

  127.           <li><a href="../demos/combination-filters.html">Combination filters</a>
    128. 

  128.         
    129. 

  129.       
    130. 

  130.         
    131. 

  131.           <li><a href="../demos/hash-history.html">Hash history</a>
    132. 

  132.         
    133. 

  133.       
    134. 

  134.         
    135. 

  135.           <li><a href="../demos/fluid-responsive.html">Fluid / responsive</a>
    136. 

  136.         
    137. 

  137.       
    138. 

  138.     </ul>
    139. 

  139.     
    140. 

  140.     <h2>Custom layout modes</h2>
    141. 

  141.     
    142. 

  142.     <ul>
    143. 

  143.       
    144. 

  144.         
    145. 

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

  146.         
    147. 

  147.       
    148. 

  148.         
    149. 

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

  150.         
    151. 

  151.       
    152. 

  152.         
    153. 

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

  154.         
    155. 

  155.       
    156. 

  156.         
    157. 

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

  158.         
    159. 

  159.       
    160. 

  160.         
    161. 

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

  162.         
    163. 

  163.       
    164. 

  164.     </ul>
    165. 

  165.     
    166. 

  166.     <h2><a href="../tests/index.html">Tests</a></h2>
    167. 

  167.     
    168. 

  168.   </nav> <!-- #site-nav -->
    169. 

  169.   
    170. 

  170.   <section id="content">
    171. 

  171.     
    172. 

  172.       <h1>Hash history with jQuery BBQ</h1>
    173. 

  173.     
    174. 

  174. 

  175.     <p>As cool as Isotope is, the only thing that could make it even cooler would be adding bookmark-able URL hashes. Ben Alman&#8217;s <a href='http://benalman.com/projects/jquery-bbq-plugin/'>jQuery BBQ</a> allows us to do just that.</p>
    176. 

  176. 

  177. <blockquote>
    178. 

  178. <p>jQuery BBQ leverages the HTML5 hashchange event to allow simple, yet powerful bookmarkable #hash history.</p>
    179. 

  179. </blockquote>
    180. 

  180. 

  181. <p><a href='../demos/hash-history.html'><strong>See Demo: Hash history</strong></a></p>
    182. 

  182. 

  183. <p>BBQ is a marvelous plugin that provides for a lot more functionality. The <a href='../demos/hash-history.html'>hash history demo</a> uses multiple options (<code>sortBy</code>, <code>sortAscending</code>, and <code>layoutMode</code> in addition to <code>filter</code>), the ability to use back-button history, and properly highlights selected links.</p>
    184. 

  184. 

  185. <p>Given BBQ&#8217;s tremendous capabilities, the code can grow to be a bit complex. Be sure to read through <a href='http://benalman.com/code/projects/jquery-bbq/docs/files/jquery-ba-bbq-js.html'>BBQ&#8217;s docs</a> and take look at <a href='http://benalman.com/code/projects/jquery-bbq/examples/'>its examples</a> before you dive in and code up your own solution.</p>
    186. 

  186. 

  187. <h2 id='markup'>Markup</h2>
    188. 

  188. 

  189. <p>Instead of setting the option values and keys with <code>data</code> attributes, we can add the option in the <code>href</code> for each link.</p>
    190. 

  190. <div class='highlight'><pre><code class='html'><span class='nt'>&lt;ul</span> <span class='na'>class=</span><span class='s'>&quot;option-set&quot;</span><span class='nt'>&gt;</span>
    191. 

  191.   <span class='nt'>&lt;li&gt;&lt;a</span> <span class='na'>href=</span><span class='s'>&quot;#filter=*&quot;</span> <span class='na'>class=</span><span class='s'>&quot;selected&quot;</span><span class='nt'>&gt;</span>show all<span class='nt'>&lt;/a&gt;&lt;/li&gt;</span>
    192. 

  192.   <span class='nt'>&lt;li&gt;&lt;a</span> <span class='na'>href=</span><span class='s'>&quot;#filter=.metal&quot;</span><span class='nt'>&gt;</span>metal<span class='nt'>&lt;/a&gt;&lt;/li&gt;</span>
    193. 

  193.   <span class='nt'>&lt;li&gt;&lt;a</span> <span class='na'>href=</span><span class='s'>&quot;#filter=.transition&quot;</span><span class='nt'>&gt;</span>transition<span class='nt'>&lt;/a&gt;&lt;/li&gt;</span>
    194. 

  194.   <span class='nt'>&lt;li&gt;&lt;a</span> <span class='na'>href=</span><span class='s'>&quot;#filter=.alkali%2C+.alkaline-earth&quot;</span><span class='nt'>&gt;</span>alkali and alkaline-earth<span class='nt'>&lt;/a&gt;&lt;/li&gt;</span>
    195. 

  195.   <span class='nt'>&lt;li&gt;&lt;a</span> <span class='na'>href=</span><span class='s'>&quot;#filter=%3Anot(.transition)&quot;</span><span class='nt'>&gt;</span>not transition<span class='nt'>&lt;/a&gt;&lt;/li&gt;</span>
    196. 

  196.   <span class='nt'>&lt;li&gt;&lt;a</span> <span class='na'>href=</span><span class='s'>&quot;#filter=.metal%3Anot(.transition)&quot;</span><span class='nt'>&gt;</span>metal but not transition<span class='nt'>&lt;/a&gt;&lt;/li&gt;</span>
    197. 

  197. <span class='nt'>&lt;/ul&gt;</span>
    198. 

  198. </code></pre>
    199. 

  199. </div>
    200. 

  200. <p>The <code>href</code> value is a serialized string, suitable for a URL. These values can be created with <a href='http://api.jquery.com/jQuery.param/'>jQuery.param()</a>.</p>
    201. 

  201. <div class='highlight'><pre><code class='javascript'><span class='nx'>$</span><span class='p'>.</span><span class='nx'>param</span><span class='p'>({</span> <span class='nx'>filter</span><span class='o'>:</span> <span class='s1'>&#39;.metal&#39;</span> <span class='p'>})</span>
    202. 

  202. <span class='c1'>// &gt;&gt; &quot;filter=.metal&quot;</span>
    203. 

  203. <span class='nx'>$</span><span class='p'>.</span><span class='nx'>param</span><span class='p'>({</span> <span class='nx'>filter</span><span class='o'>:</span> <span class='s1'>&#39;.alkali, alkaline-earth&#39;</span> <span class='p'>})</span>
    204. 

  204. <span class='c1'>// &gt;&gt; &quot;filter=.alkali%2C+alkaline-earth&quot;</span>
    205. 

  205. <span class='nx'>$</span><span class='p'>.</span><span class='nx'>param</span><span class='p'>({</span> <span class='nx'>filter</span><span class='o'>:</span> <span class='s1'>&#39;:not(.transition)&#39;</span> <span class='p'>})</span>
    206. 

  206. <span class='c1'>// &gt;&gt; &quot;#filter=%3Anot(.transition)&quot;</span>
    207. 

  207. </code></pre>
    208. 

  208. </div>
    209. 

  209. <h2 id='jquery_script'>jQuery script</h2>
    210. 

  210. 

  211. <p>These serialized <code>href</code> values can be converted into their proper jQuery object form when clicked using <a href='http://benalman.com/code/projects/jquery-bbq/docs/files/jquery-ba-bbq-js.html#jQuery.deparam'>jQuery.deparam()</a> from jQuery BBQ.</p>
    212. 

  212. <div class='highlight'><pre><code class='javascript'><span class='nx'>$</span><span class='p'>(</span><span class='s1'>&#39;.option-set a&#39;</span><span class='p'>).</span><span class='nx'>click</span><span class='p'>(</span><span class='kd'>function</span><span class='p'>(){</span>
    213. 

  213.       <span class='c1'>// get href attr, remove leading #</span>
    214. 

  214.   <span class='kd'>var</span> <span class='nx'>href</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'>&#39;href&#39;</span><span class='p'>).</span><span class='nx'>replace</span><span class='p'>(</span> <span class='sr'>/^#/</span><span class='p'>,</span> <span class='s1'>&#39;&#39;</span> <span class='p'>),</span>
    215. 

  215.       <span class='c1'>// convert href into object</span>
    216. 

  216.       <span class='c1'>// i.e. &#39;filter=.inner-transition&#39; -&gt; { filter: &#39;.inner-transition&#39; }</span>
    217. 

  217.       <span class='nx'>option</span> <span class='o'>=</span> <span class='nx'>$</span><span class='p'>.</span><span class='nx'>deparam</span><span class='p'>(</span> <span class='nx'>href</span><span class='p'>,</span> <span class='kc'>true</span> <span class='p'>);</span>
    218. 

  218.   <span class='c1'>// set hash, triggers hashchange on window</span>
    219. 

  219.   <span class='nx'>$</span><span class='p'>.</span><span class='nx'>bbq</span><span class='p'>.</span><span class='nx'>pushState</span><span class='p'>(</span> <span class='nx'>option</span> <span class='p'>);</span>
    220. 

  220.   <span class='k'>return</span> <span class='kc'>false</span><span class='p'>;</span>
    221. 

  221. <span class='p'>});</span>
    222. 

  222. </code></pre>
    223. 

  223. </div>
    224. 

  224. <p>Calling <a href='http://benalman.com/code/projects/jquery-bbq/docs/files/jquery-ba-bbq-js.html#jQuery.bbq.pushState'>$.bbq.pushState()</a> will trigger the <code>hashchange</code> event. At that point, we can parse the hash from the URL and use it to trigger the proper change in the Isotope instance.</p>
    225. 

  225. <div class='highlight'><pre><code class='javascript'><span class='nx'>$</span><span class='p'>(</span><span class='nb'>window</span><span class='p'>).</span><span class='nx'>bind</span><span class='p'>(</span> <span class='s1'>&#39;hashchange&#39;</span><span class='p'>,</span> <span class='kd'>function</span><span class='p'>(</span> <span class='nx'>event</span> <span class='p'>){</span>
    226. 

  226.   <span class='c1'>// get options object from hash</span>
    227. 

  227.   <span class='kd'>var</span> <span class='nx'>hashOptions</span> <span class='o'>=</span> <span class='nx'>$</span><span class='p'>.</span><span class='nx'>deparam</span><span class='p'>.</span><span class='nx'>fragment</span><span class='p'>();</span>
    228. 

  228.   <span class='c1'>// apply options from hash</span>
    229. 

  229.   <span class='nx'>$container</span><span class='p'>.</span><span class='nx'>isotope</span><span class='p'>(</span> <span class='nx'>hashOptions</span> <span class='p'>);</span>
    230. 

  230. <span class='p'>})</span>
    231. 

  231.   <span class='c1'>// trigger hashchange to capture any hash data on init</span>
    232. 

  232.   <span class='p'>.</span><span class='nx'>trigger</span><span class='p'>(</span><span class='s1'>&#39;hashchange&#39;</span><span class='p'>);</span>
    233. 

  233. </code></pre>
    234. 

  234. </div>
    235. 

  235. <p>Now any filter buttons that are clicked will update the URL hash, so these options can be bookmarked.</p>
    236. 

  236.     
    237. 

  237.     <footer>
    238. 

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

  239.     </footer>
    240. 

  240.     
    241. 

  241.   </section> <!-- #content -->
    242. 

  242.   
    243. 

  243. 

  244. </body>
    245. 

  245. </html>
    246.