You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
16 lines
1.3 KiB
HTML
16 lines
1.3 KiB
HTML
<h2>Public Methods<a href="#public-methods"></a></h2>
|
|
<p>A list of the methods available to you and what they do.</p>
|
|
|
|
<ul>
|
|
<li><code>filter(category, sortObject)</code> - Filters all the shuffle items and then sorts them. <code>category</code> can be a string, array of strings, or a function. The sort object is optional and will use the last-used sort object.</li>
|
|
<li><code>sort(sortObject)</code> - Sorts the currently filtered shuffle items.</li>
|
|
<li><code>update()</code> - Repositions everything. Useful for when dimensions (like the window size) change.</li>
|
|
<li><code>layout()</code> - Use this instead of <code>update()</code> if you don't need the columns and gutters updated. Maybe an image loaded and now has a height.</li>
|
|
<li><code>add(newItems)</code> - New items have been appended to the shuffle container. <code>newItems</code> is an array of elements.</li>
|
|
<li><code>disable()</code> - Disables Shuffle from updating dimensions and layout on resize.</li>
|
|
<li><code>enable()</code> - Enables Shuffle again.</li>
|
|
<li><code>remove()</code> - Remove one or more shuffle items.</li>
|
|
<li><code>getItemByElement(element)</code> - Retrieve a <code>ShuffleItem</code> by its element.</li>
|
|
<li><code>destroy()</code> - Destroys Shuffle, removes events, styles, classes, and references.</li>
|
|
</ul>
|