Update docs and options descriptions.

_includes/changelog.html

@@ -1,5 +1,6 @@
 <h2>Changes<a href="#changelog"></a></h2>
 <ul>
+  <li><code>v2.1.2</code> 6/01/14 - Use <code>window.jQuery</code> instead of <code>window.$</code> to work better with noConflict. Fixed <a href="https://github.com/Vestride/Shuffle/issues/25">#25</a>.</li>
   <li><code>v2.1.1</code> 4/16/14 - Fix items with zero opacity overlapping visible ones in IE&lt;10.</li>
   <li><code>v2.1.0</code> 4/12/14 - Register with bower as <code>shufflejs</code>.</li>
   <li>4/10/14 - Add AMD support.</li>

_includes/events.html

@@ -3,14 +3,9 @@
 <ul class="breathable-list">
   <li><code class="language-javascript">'loading.shuffle'</code></li>
   <li><code class="language-javascript">'done.shuffle'</code></li>
-  <li><code class="language-javascript">'shrink.shuffle'</code></li>
-  <li><code class="language-javascript">'shrunk.shuffle'</code></li>
-  <li><code class="language-javascript">'filter.shuffle'</code></li>
-  <li><code class="language-javascript">'filtered.shuffle'</code></li>
   <li><code class="language-javascript">'layout.shuffle'</code></li>
   <li><code class="language-javascript">'removed.shuffle'</code></li>
 </ul>
-<p><strong>Heads up!</strong> To receive the <code>loading</code> event, you must subscribe to it before initializing the plugin, otherwise it will fire before you have subscribed to it.</p>
 
 <h3>Get notified when shuffle is done with setup</h3>
 <pre rel="JavaScript"><code class="language-javascript">$grid.on('done.shuffle', function() {

_includes/options.html

@@ -1,22 +1,22 @@
 <h2>Options<a href="#options"></a></h2>
 
-<p>Settings you can change (these are the defaults)</p>
+<p>Settings you can change (these are the defaults).</p>
 <pre rel="JavaScript"><code class="language-javascript">// Overrideable options
 Shuffle.options = {
-    group: 'all', // Filter group
-    speed: 250, // Transition/animation speed (milliseconds)
-    easing: 'ease-out', // css easing function to use
-    itemSelector: '', // e.g. '.picture-item'
-    sizer: null, // sizer element. Can be anything columnWidth is
-    gutterWidth: 0, // a static number or function that tells the plugin how wide the gutters between columns are (in pixels)
-    columnWidth: 0, // a static number or function that returns a number which tells the plugin how wide the columns are (in pixels)
-    delimeter: null, // if your group is not json, and is comma delimeted, you could set delimeter to ','
-    buffer: 0, // useful for percentage based heights when they might not always be exactly the same (in pixels)
-    initialSort: null, // Shuffle can be initialized with a sort object. It is the same object given to the sort method
-    throttle: $.throttle || null, // By default, shuffle will try to throttle the resize event. This option will change the method it uses
-    throttleTime: 300, // How often shuffle can be called on resize (in milliseconds)
-    sequentialFadeDelay: 150, // Delay between each item that fades in when adding items
-    supported: Modernizr.csstransforms &amp;&amp; Modernizr.csstransitions // supports transitions and transforms
+  group: ALL_ITEMS, // Initial filter group.
+  speed: 250, // Transition/animation speed (milliseconds).
+  easing: 'ease-out', // CSS easing function to use.
+  itemSelector: '', // e.g. '.picture-item'.
+  sizer: null, // Sizer element. Use an element to determine the size of columns and gutters.
+  gutterWidth: 0, // A static number or function that tells the plugin how wide the gutters between columns are (in pixels).
+  columnWidth: 0, // A static number or function that returns a number which tells the plugin how wide the columns are (in pixels).
+  delimeter: null, // If your group is not json, and is comma delimeted, you could set delimeter to ','.
+  buffer: 0, // Useful for percentage based heights when they might not always be exactly the same (in pixels).
+  initialSort: null, // Shuffle can be initialized with a sort object. It is the same object given to the sort method.
+  throttle: throttle, // By default, shuffle will throttle resize events. This can be changed or removed.
+  throttleTime: 300, // How often shuffle can be called on resize (in milliseconds).
+  sequentialFadeDelay: 150, // Delay between each item that fades in when adding items.
+  supported: CAN_TRANSITION_TRANSFORMS // Whether to use transforms or absolute positioning.
 };</code></pre>
 
 <p>No options <em>need</em> to be specified, but <code>itemSelector</code> should be used. Other common options to change are <code>speed</code>, <code>easing</code>, <code>gutterWidth</code>, and <code>columnWidth</code> (or <code>sizer</code>).</p>

dist/jquery.shuffle.js

@@ -167,7 +167,6 @@ var Shuffle = function( element, options ) {
 Shuffle.EventType = {
   LOADING: 'loading',
   DONE: 'done',
-  SORTED: 'sorted',
   LAYOUT: 'layout',
   REMOVED: 'removed'
 };
@@ -1306,19 +1305,19 @@ Shuffle.prototype.destroy = function() {
 // Overrideable options
 Shuffle.options = {
   group: ALL_ITEMS, // Initial filter group.
-  speed: 250, // Transition/animation speed (milliseconds)
-  easing: 'ease-out', // css easing function to use
-  itemSelector: '', // e.g. '.picture-item'
-  sizer: null, // sizer element. Use an element to determine the size of columns and gutters.
-  gutterWidth: 0, // a static number or function that tells the plugin how wide the gutters between columns are (in pixels)
-  columnWidth: 0, // a static number or function that returns a number which tells the plugin how wide the columns are (in pixels)
-  delimeter: null, // if your group is not json, and is comma delimeted, you could set delimeter to ','
-  buffer: 0, // useful for percentage based heights when they might not always be exactly the same (in pixels)
-  initialSort: null, // Shuffle can be initialized with a sort object. It is the same object given to the sort method
-  throttle: throttle, // By default, shuffle will try to throttle the resize event. This option will change the method it uses
-  throttleTime: 300, // How often shuffle can be called on resize (in milliseconds)
-  sequentialFadeDelay: 150, // Delay between each item that fades in when adding items
-  supported: CAN_TRANSITION_TRANSFORMS // supports transitions and transforms
+  speed: 250, // Transition/animation speed (milliseconds).
+  easing: 'ease-out', // CSS easing function to use.
+  itemSelector: '', // e.g. '.picture-item'.
+  sizer: null, // Sizer element. Use an element to determine the size of columns and gutters.
+  gutterWidth: 0, // A static number or function that tells the plugin how wide the gutters between columns are (in pixels).
+  columnWidth: 0, // A static number or function that returns a number which tells the plugin how wide the columns are (in pixels).
+  delimeter: null, // If your group is not json, and is comma delimeted, you could set delimeter to ','.
+  buffer: 0, // Useful for percentage based heights when they might not always be exactly the same (in pixels).
+  initialSort: null, // Shuffle can be initialized with a sort object. It is the same object given to the sort method.
+  throttle: throttle, // By default, shuffle will throttle resize events. This can be changed or removed.
+  throttleTime: 300, // How often shuffle can be called on resize (in milliseconds).
+  sequentialFadeDelay: 150, // Delay between each item that fades in when adding items.
+  supported: CAN_TRANSITION_TRANSFORMS // Whether to use transforms or absolute positioning.
 };
 
 

dist/jquery.shuffle.modernizr.js

@@ -173,7 +173,6 @@ var Shuffle = function( element, options ) {
 Shuffle.EventType = {
   LOADING: 'loading',
   DONE: 'done',
-  SORTED: 'sorted',
   LAYOUT: 'layout',
   REMOVED: 'removed'
 };
@@ -1312,19 +1311,19 @@ Shuffle.prototype.destroy = function() {
 // Overrideable options
 Shuffle.options = {
   group: ALL_ITEMS, // Initial filter group.
-  speed: 250, // Transition/animation speed (milliseconds)
-  easing: 'ease-out', // css easing function to use
-  itemSelector: '', // e.g. '.picture-item'
-  sizer: null, // sizer element. Use an element to determine the size of columns and gutters.
-  gutterWidth: 0, // a static number or function that tells the plugin how wide the gutters between columns are (in pixels)
-  columnWidth: 0, // a static number or function that returns a number which tells the plugin how wide the columns are (in pixels)
-  delimeter: null, // if your group is not json, and is comma delimeted, you could set delimeter to ','
-  buffer: 0, // useful for percentage based heights when they might not always be exactly the same (in pixels)
-  initialSort: null, // Shuffle can be initialized with a sort object. It is the same object given to the sort method
-  throttle: throttle, // By default, shuffle will try to throttle the resize event. This option will change the method it uses
-  throttleTime: 300, // How often shuffle can be called on resize (in milliseconds)
-  sequentialFadeDelay: 150, // Delay between each item that fades in when adding items
-  supported: CAN_TRANSITION_TRANSFORMS // supports transitions and transforms
+  speed: 250, // Transition/animation speed (milliseconds).
+  easing: 'ease-out', // CSS easing function to use.
+  itemSelector: '', // e.g. '.picture-item'.
+  sizer: null, // Sizer element. Use an element to determine the size of columns and gutters.
+  gutterWidth: 0, // A static number or function that tells the plugin how wide the gutters between columns are (in pixels).
+  columnWidth: 0, // A static number or function that returns a number which tells the plugin how wide the columns are (in pixels).
+  delimeter: null, // If your group is not json, and is comma delimeted, you could set delimeter to ','.
+  buffer: 0, // Useful for percentage based heights when they might not always be exactly the same (in pixels).
+  initialSort: null, // Shuffle can be initialized with a sort object. It is the same object given to the sort method.
+  throttle: throttle, // By default, shuffle will throttle resize events. This can be changed or removed.
+  throttleTime: 300, // How often shuffle can be called on resize (in milliseconds).
+  sequentialFadeDelay: 150, // Delay between each item that fades in when adding items.
+  supported: CAN_TRANSITION_TRANSFORMS // Whether to use transforms or absolute positioning.
 };
 
 

src/shuffle.js

@@ -150,7 +150,6 @@ var Shuffle = function( element, options ) {
 Shuffle.EventType = {
   LOADING: 'loading',
   DONE: 'done',
-  SORTED: 'sorted',
   LAYOUT: 'layout',
   REMOVED: 'removed'
 };
@@ -1289,19 +1288,19 @@ Shuffle.prototype.destroy = function() {
 // Overrideable options
 Shuffle.options = {
   group: ALL_ITEMS, // Initial filter group.
-  speed: 250, // Transition/animation speed (milliseconds)
-  easing: 'ease-out', // css easing function to use
-  itemSelector: '', // e.g. '.picture-item'
-  sizer: null, // sizer element. Use an element to determine the size of columns and gutters.
-  gutterWidth: 0, // a static number or function that tells the plugin how wide the gutters between columns are (in pixels)
-  columnWidth: 0, // a static number or function that returns a number which tells the plugin how wide the columns are (in pixels)
-  delimeter: null, // if your group is not json, and is comma delimeted, you could set delimeter to ','
-  buffer: 0, // useful for percentage based heights when they might not always be exactly the same (in pixels)
-  initialSort: null, // Shuffle can be initialized with a sort object. It is the same object given to the sort method
-  throttle: throttle, // By default, shuffle will try to throttle the resize event. This option will change the method it uses
-  throttleTime: 300, // How often shuffle can be called on resize (in milliseconds)
-  sequentialFadeDelay: 150, // Delay between each item that fades in when adding items
-  supported: CAN_TRANSITION_TRANSFORMS // supports transitions and transforms
+  speed: 250, // Transition/animation speed (milliseconds).
+  easing: 'ease-out', // CSS easing function to use.
+  itemSelector: '', // e.g. '.picture-item'.
+  sizer: null, // Sizer element. Use an element to determine the size of columns and gutters.
+  gutterWidth: 0, // A static number or function that tells the plugin how wide the gutters between columns are (in pixels).
+  columnWidth: 0, // A static number or function that returns a number which tells the plugin how wide the columns are (in pixels).
+  delimeter: null, // If your group is not json, and is comma delimeted, you could set delimeter to ','.
+  buffer: 0, // Useful for percentage based heights when they might not always be exactly the same (in pixels).
+  initialSort: null, // Shuffle can be initialized with a sort object. It is the same object given to the sort method.
+  throttle: throttle, // By default, shuffle will throttle resize events. This can be changed or removed.
+  throttleTime: 300, // How often shuffle can be called on resize (in milliseconds).
+  sequentialFadeDelay: 150, // Delay between each item that fades in when adding items.
+  supported: CAN_TRANSITION_TRANSFORMS // Whether to use transforms or absolute positioning.
 };