Vestride_Shuffle/_includes/usage.html

<h2>Usage<a href="#usage"></a></h2>

<h3>The HTML Structure</h3>
<p>The only real important thing here is the <code class="language-markup token attr-name">data-groups</code> attribute. It has to be a <a href="http://jsonlint.com/">valid JSON</a> array of strings. Optionally, it can be a string delimeted by a value you provide. See <code>delimeter</code> in the <a href="#options">options</a>.</p>

<p>In this example, shuffle is using the fluid grid from the <a href="http://twitter.github.io/bootstrap/">Twitter Bootstrap v2.3</a>. It's also making use of <a href="http://csswizardry.com/2013/01/mindbemding-getting-your-head-round-bem-syntax/"><abbr title="Block-Element-Modifier">BEM</abbr></a> class naming.</p>

<div class="code-block">
  <pre rel="HTML"><code class="language-markup">&lt;div id="grid" class="row"&gt;
  &lt;figure class="col-3@sm picture-item" data-groups='["photography"]'&gt;
    &lt;img src="/img/baseball.png" height="145" width="230" /&gt;
    &lt;div class="picture-item__details"&gt;
      &lt;figcaption class="picture-item__title"&gt;Baseball&lt;/figcaption&gt;
      &lt;p class="picture-item__tags"&gt;photography&lt;/p&gt;
    &lt;/div&gt;
  &lt;/figure&gt;
  &lt;figure class="col-6@sm picture-item" data-groups='["wallpaper","3d"]'&gt;
    &lt;img src="/img/tennis-ball.png" height="145" width="230" /&gt;
    &lt;div class="picture-item__details"&gt;
      &lt;figcaption class="picture-item__title"&gt;Tennis&lt;/figcaption&gt;
      &lt;p class="picture-item__tags"&gt;wallpaper, 3d&lt;/p&gt;
    &lt;/div&gt;
    &lt;p class="picture-item__description"&gt;Some description here.&lt;/p&gt;
  &lt;/figure&gt;
  &lt;figure class="col-3@sm picture-item" data-groups='["wallpaper","3d"]'&gt;
    &lt;img src="/img/imac.png" height="145" width="230" /&gt;
    &lt;div class="picture-item__details"&gt;
      &lt;figcaption class="picture-item__title"&gt;iMac&lt;/figcaption&gt;
      &lt;p class="picture-item__tags"&gt;wallpaper, 3d&lt;/p&gt;
    &lt;/div&gt;
  &lt;/figure&gt;
  &lt;figure class="col-3@sm picture-item picture-item--h2" data-groups='["graphics"]'&gt;
    &lt;img src="/img/master-chief.png" height="145" width="230" /&gt;
    &lt;div class="picture-item__details"&gt;
      &lt;figcaption class="picture-item__title"&gt;Master Chief&lt;/figcaption&gt;
      &lt;p class="picture-item__tags"&gt;graphics&lt;/p&gt;
    &lt;/div&gt;
    &lt;p class="picture-item__description"&gt;Some description here.&lt;/p&gt;
  &lt;/figure&gt;
&lt;/div&gt;</code></pre>
</div>

<h3 id="columns">How column widths work<a href="#how-column-widths-work"></a></h3>
<p>The <code>columnWidth</code> option is used to calculate the column width. You have several options:</p>
<ol>
  <li>Use a <strong>sizer</strong> element. This is the easest way to specify column and gutter widths. You can use an element or an element wrapped in jQuery to define the column width and gutter width. Shuffle will measure the <code>width</code> and <code>margin-left</code> of this <code>sizer</code> element each time the grid resizes. This is awesome for responsive or fluid grids where the width of a column is a percentage. The <code>sizer</code> option is an alias for <code>columnWidth</code>.<span class="demo-link-container">See <a href="{{ site.baseurl }}{% post_url 2013-05-01-basic %}">a demo</a> using a sizer element or <a href="{{ site.baseurl }}/js/demos/homepage.js">look at the js file</a> for the sizer demo.</span></li>
  <li>Use a <strong>function</strong>. When a function is used, its first parameter will be the width of the shuffle element. You need to return the column width for shuffle to use (in pixels).</li>
  <li>A <strong>number</strong>. This will explicitly set the column width to your number (in pixels).</li>
  <li>By default, shuffle will use the width of the first item to calculate the column width.</li>
</ol>

<h3>A basic setup example</h3>
<p>If you want functional buttons, check out <a href="{{ site.baseurl }}/js/demos/homepage.js">the js file</a>.</p>
<div class="code-block">
  <pre rel="JavaScript"><code class="language-javascript">$(document).ready(function() {
  var $grid = $('#grid'),
      $sizer = $grid.find('.shuffle__sizer');

  $grid.shuffle({
    itemSelector: '.picture-item',
    sizer: $sizer
  });
});</code></pre>
</div>