First commit of jQuery.fn.sort

yinbinxu · Mar 18, 2010 · 2bc8e5e · 2bc8e5e
1 parent 3db614a
commit 2bc8e5e
Show file tree

Hide file tree

Showing 3 changed files with 191 additions and 0 deletions.
diff --git a/sort/README.md b/sort/README.md
@@ -0,0 +1,35 @@
+sort
+---
+
+The sort plugin is a very basic low-level element sorting function that allows you to sort DOM elements with a custom comparator (similar to `Array.prototype.sort`).
+
+Assuming the following markup:
+
+    <ul>
+        <li>Banana</li>
+        <li>Carrot</li>
+        <li>Apple</li>
+    </ul>
+
+You could sort the items alphabetically like so:
+
+    $('li').sort(function(a, b){
+        return $(a).text() > $(b).text() ? 1 : -1;
+    });
+
+That would result in:
+
+    <ul>
+        <li>Apple</li>
+        <li>Banana</li>
+        <li>Carrot</li>
+    </ul>
+
+It also let's you specify what element will be sorted. The current collection's elements will be those referred to as `a` and `b` on each call of the comparator, but you might not want those elements to be the ones to move. E.g. you might want it to be a parent. For example, when sorting a table column, you would sort by the `<td>` elements, but the elements you actually want to move within the DOM are the `<tr>` (each `<td>`'s parent):
+
+    $('td').sort(myComparator, function(){
+        // Return a reference to the desired element:
+        return this.parentNode;
+    });
+
+See more info here: 
diff --git a/sort/demo.html b/sort/demo.html
@@ -0,0 +1,87 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+            <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+            <title>Sort plugin for jQuery</title>
+    </head>
+    <body>
+
+        <h1>Demo</h1>
+
+        <p>Click on the headers (fruit/quantity).</p>
+
+        <table>
+            <thead>
+                <tr>
+                    <th>Fruit</th>
+                    <th>Quantity</th>
+                </tr>
+            </thead>
+            <tbody>
+                <tr>
+                    <td>Grape</td>
+                    <td>15</td>
+                </tr>
+                <tr>
+                    <td>Apple</td>
+                    <td>4</td>
+                </tr>
+                <tr>
+                    <td>Banana</td>
+                    <td>88</td>
+                </tr>
+                <tr>
+                    <td>Orange</td>
+                    <td>11</td>
+                </tr>
+                <tr>
+                    <td>Melon</td>
+                    <td>21</td>
+                </tr>
+                <tr>
+                    <td>Tomato</td>
+                    <td>36</td>
+                </tr>
+            </tbody>
+        </table>
+
+        <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.4.2/jquery.min.js"></script>
+        <script src="jquery.sort.js"></script>
+        <script>
+            var th = jQuery('th'),
+                inverse = false;
+
+            th.click(function(){
+
+                var header = $(this),
+                    index = header.index();
+
+                header
+                    .closest('table')
+                    .find('td')
+                    .filter(function(){
+                        return $(this).index() === index;
+                    })
+                    .sort(function(a, b){
+
+                        a = $(a).text();
+                        b = $(b).text();
+
+                        return (
+                            isNaN(a) || isNaN(b) ?
+                                a > b : +a > +b
+                            ) ?
+                                inverse ? -1 : 1 :
+                                inverse ? 1 : -1;
+
+                    }, function(){
+                        return this.parentNode;
+                    });
+
+                inverse = !inverse;
+
+            });
+        </script>
+
+    </body>
+</html>
diff --git a/sort/jquery.sort.js b/sort/jquery.sort.js
@@ -0,0 +1,69 @@
+/**
+ * jQuery.fn.sort
+ * --------------
+ * @author James Padolsey (http://james.padolsey.com)
+ * @version 0.1
+ * @updated 18-MAR-2010
+ * --------------
+ * @param Function comparator:
+ *   Exactly the same behaviour as [1,2,3].sort(comparator)
+ *   
+ * @param Function getSortable
+ *   A function that should return the element that is
+ *   to be sorted. The comparator will run on the
+ *   current collection, but you may want the actual
+ *   resulting sort to occur on a parent or another
+ *   associated element.
+ *   
+ *   E.g. $('td').sort(comparator, function(){
+ *      return this.parentNode; 
+ *   })
+ *   
+ *   The <td>'s parent (<tr>) will be sorted instead
+ *   of the <td> itself.
+ */
+jQuery.fn.sort = (function(){
+
+    var sort = [].sort;
+
+    return function(comparator, getSortable) {
+
+        getSortable = getSortable || function(){return this;};
+
+        var placements = this.map(function(){
+
+            var sortElement = getSortable.call(this),
+                parentNode = sortElement.parentNode,
+
+                // Since the element itself will change position, we have
+                // to have some way of storing it's original position in
+                // the DOM. The easiest way is to have a 'flag' node:
+                nextSibling = parentNode.insertBefore(
+                    document.createTextNode(''),
+                    sortElement.nextSibling
+                );
+
+            return function() {
+
+                if (parentNode === this) {
+                    throw new Error(
+                        "You can't sort elements if any one is a descendant of another."
+                    );
+                }
+
+                // Insert before flag:
+                parentNode.insertBefore(this, nextSibling);
+                // Remove flag:
+                parentNode.removeChild(nextSibling);
+
+            };
+
+        });
+
+        return sort.call(this, comparator).each(function(i){
+            placements[i].call(getSortable.call(this));
+        });
+
+    };
+
+})();