mirror of
https://github.com/Mottie/tablesorter.git
synced 2024-10-08 13:44:18 +00:00
354 lines
14 KiB
HTML
354 lines
14 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>jQuery plugin: Tablesorter 2.0 - Custom Filter Widget Formatter (HTML5 Elements)</title>
|
|
|
|
<!-- jQuery -->
|
|
<script src="js/jquery-latest.min.js"></script>
|
|
|
|
<!-- Demo stuff -->
|
|
<link class="ui-theme" rel="stylesheet" href="css/jquery-ui.min.css">
|
|
<script src="js/jquery-ui.min.js"></script>
|
|
<link rel="stylesheet" href="css/jq.css">
|
|
<link href="css/prettify.css" rel="stylesheet">
|
|
<script src="js/prettify.js"></script>
|
|
<script src="js/docs.js"></script>
|
|
|
|
<!-- Tablesorter: required -->
|
|
<link href="../css/theme.blue.css" rel="stylesheet">
|
|
<link href="../css/filter.formatter.css" rel="stylesheet">
|
|
<script src="../js/jquery.tablesorter.js"></script>
|
|
<script src="../js/jquery.tablesorter.widgets.js"></script>
|
|
<script src="../js/jquery.tablesorter.widgets-filter-formatter.js"></script>
|
|
|
|
<style id="css">/* css needed to get compare selector & slider in-line */
|
|
.compare-select-wrapper { width: 60%; float: right; }</style>
|
|
|
|
<script id="js">$(function() {
|
|
|
|
$("table").tablesorter({
|
|
theme: 'blue',
|
|
// hidden filter input/selects will resize the columns, so try to minimize the change
|
|
widthFixed : true,
|
|
// initialize zebra striping and filter widgets
|
|
widgets: ["zebra", "filter", "stickyHeaders"],
|
|
widgetOptions : {
|
|
// Use the $.tablesorter.storage utility to save the most recent filters
|
|
filter_saveFilters : true,
|
|
// jQuery selector string of an element used to reset the filters
|
|
filter_reset : 'button.reset',
|
|
// add custom selector elements to the filter row
|
|
filter_formatter : {
|
|
|
|
// Rank
|
|
0 : function($cell, indx){
|
|
return $.tablesorter.filterFormatter.html5Range( $cell, indx, {
|
|
value: 0,
|
|
min: 0,
|
|
max: 100,
|
|
delayed: true,
|
|
valueToHeader: true,
|
|
compare : [ '=', '>=', '<=' ],
|
|
selected: 1
|
|
});
|
|
},
|
|
|
|
// Color
|
|
1 : function($cell, indx){
|
|
return $.tablesorter.filterFormatter.html5Color( $cell, indx, {
|
|
value: '#000000',
|
|
addToggle: true,
|
|
exactMatch: true,
|
|
valueToHeader: false
|
|
});
|
|
},
|
|
|
|
// Age
|
|
3: function($cell, indx){
|
|
return $.tablesorter.filterFormatter.html5Number( $cell, indx, {
|
|
value: 1,
|
|
min: 1,
|
|
max: 65,
|
|
delayed: true,
|
|
addToggle: true,
|
|
exactMatch: true,
|
|
compare: ''
|
|
});
|
|
},
|
|
|
|
// Total
|
|
4 : function($cell, indx){
|
|
return $.tablesorter.filterFormatter.html5Range( $cell, indx, {
|
|
value: 0,
|
|
min: 0,
|
|
max: 150,
|
|
delayed: true,
|
|
valueToHeader: true,
|
|
compare : '>='
|
|
});
|
|
},
|
|
|
|
// Discount
|
|
5: function($cell, indx){
|
|
return $.tablesorter.filterFormatter.html5Number( $cell, indx, {
|
|
value: 1,
|
|
min: 1,
|
|
max: 44,
|
|
delayed: true,
|
|
addToggle: false,
|
|
compare: [ '<=', '=', '>=' ],
|
|
selected: 2
|
|
});
|
|
}
|
|
|
|
}
|
|
}
|
|
});
|
|
|
|
});</script>
|
|
|
|
</head>
|
|
<body>
|
|
<div id="banner">
|
|
<h1>table<em>sorter</em></h1>
|
|
<h2>Custom Filter Widget Formatter (HTML5 Elements)</h2>
|
|
<h3>Flexible client-side table sorting</h3>
|
|
<a href="index.html">Back to documentation</a>
|
|
</div>
|
|
<div id="main">
|
|
|
|
<p></p>
|
|
<br>
|
|
<div class="accordion">
|
|
|
|
<h3><a href="#">Notes</a></h3>
|
|
<div>
|
|
<ul>
|
|
<li>In <span class="version updated">v2.17.0</span>, the <code>filter_formatter</code> column can also be referenced by using a jQuery selector (e.g. class name or ID).</li>
|
|
<li>As of tablesorter version 2.9+, this widget can no longer be applied to versions of tablesorter prior to version 2.8.</li>
|
|
<li>At this time, these widgets do not work with the sticky header widget.</li>
|
|
<li>This page shows you how to add a few default <strong>HTML5 elements</strong> to interact with the filter widget.</li>
|
|
<li>If the HTML5 elements are not supported by your browser, you'll just see an input.</li>
|
|
<li>Custom filter widget option <code>filter_formatter</code> was added in version 2.7.7.</li>
|
|
<li>jQuery v1.4.3+ required.</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<h3><a href="#"><strong>HTML Range</strong></a> <span class="xsmall">("Rank" and "Total" columns)</span></h3>
|
|
<div>
|
|
<ul>
|
|
<li>In <span class="version">v2.15.0</span> the <code>compare</code> option was updated to allow adding a selector along with the input. The <code>selected</code> option allows choosing the default setting.</li>
|
|
<li>This example shows how you can add an HTML5 range input slider to filter column content.</li>
|
|
<li>The <code>filter_formatter</code> function provided in the extra "jquery.tablesorter.widgets-filter-formatter.js" file is used to add this custom control within the filter row.</li>
|
|
<li>Make sure to include all values within the selected range, otherwise rows outside of this range will be forever hidden.</li>
|
|
<li>Add the following code to apply an HTML5 range slider to the filter row:<pre class="prettyprint lang-javascript">$(function() {
|
|
|
|
$("table").tablesorter({
|
|
theme: 'blue',
|
|
// initialize zebra striping and filter widgets
|
|
widgets: ["zebra", "filter"],
|
|
widgetOptions : {
|
|
// jQuery selector string of an element used to reset the filters
|
|
filter_reset : 'button.reset',
|
|
// add custom selector elements to the filter row
|
|
filter_formatter : {
|
|
|
|
// Rank
|
|
0 : function($cell, indx){
|
|
return $.tablesorter.filterFormatter.html5Range( $cell, indx, {
|
|
value: 0,
|
|
min: 0,
|
|
max: 100,
|
|
delayed: true,
|
|
valueToHeader: true,
|
|
compare : [ '=', '>=', '<=' ],
|
|
selected: 1
|
|
});
|
|
},
|
|
|
|
// Total
|
|
4 : function($cell, indx){
|
|
return $.tablesorter.filterFormatter.html5Range( $cell, indx, {
|
|
value: 0,
|
|
min: 0,
|
|
max: 150,
|
|
delayed: true,
|
|
valueToHeader: true,
|
|
compare : '>='
|
|
});
|
|
}
|
|
|
|
}
|
|
}
|
|
});
|
|
|
|
});</pre></li>
|
|
<li>By default, this code has the <code>valueToHeader</code> option set to <code>true</code> to add the slider value to the header cell above the filter.</li>
|
|
<li>The tooltip above the slider is NOT added in this example because the slider handle is not a separate element. But if you are interested, you can use <a href="http://codepen.io/chriscoyier/pen/lokyH">this code</a> by Chris Coyier to animate a range slider bubble.</li>
|
|
<li>Another option named <code>exactMatch</code> was added to allow exact or general matching of column content.</li>
|
|
<li>Notice that the left-most value, zero in this case, will clear the column filter to allow a method to show all column content. You can modify the "all" text using the <code>allText</code> option.</li>
|
|
<li>A search delay option was added in v2.7.11 (time set by <code>filter_searchDelay</code> option). It can be disabled by setting the <code>delayed</code> option to <code>false</code>.</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<h3><a href="#"><strong>HTML5 color input</strong></a> <span class="xsmall">("Color" column)</span></h3>
|
|
<div>
|
|
<ul>
|
|
<li>This example shows how you can add an HTML5 color input to filter column content.</li>
|
|
<li>The <code>filter_formatter</code> function is used to add a custom control within the filter row, but a hidden input is still required to store the filter value.</li>
|
|
<li>Add the following code to apply a color input to the filter row:<pre class="prettyprint lang-javascript">$(function() {
|
|
|
|
$("table").tablesorter({
|
|
theme: 'blue',
|
|
// hidden filter input/selects will resize the columns, so try to minimize the change
|
|
widthFixed : true,
|
|
// initialize zebra striping and filter widgets
|
|
widgets: ["zebra", "filter"],
|
|
widgetOptions : {
|
|
// jQuery selector string of an element used to reset the filters
|
|
filter_reset : 'button.reset',
|
|
// add custom selector elements to the filter row
|
|
filter_formatter : {
|
|
|
|
// Color
|
|
1 : function($cell, indx){
|
|
return $.tablesorter.filterFormatter.html5Color( $cell, indx, {
|
|
value: '#000000',
|
|
addToggle: true,
|
|
exactMatch: true,
|
|
valueToHeader: false
|
|
});
|
|
}
|
|
|
|
}
|
|
}
|
|
});
|
|
|
|
});</pre></li>
|
|
<li>This color selector will only output the color as a hex value with a hash followed by six characters (<code>#000000</code>).</li>
|
|
<li>By default, this code has the <code>valueToHeader</code> option set to <code>false</code>. The currently selected color is added to a span within the cell by default.</li>
|
|
<li>Another option named <code>exactMatch</code> was added to allow exact or general matching of column content, in case you have multiple colors in one cell.</li>
|
|
<li>This selector includes a toggle button. The toggle button is added by default, but if you don't want it, set the <code>addToggle</code> option to <code>false</code>. Without the toggle button, the filter is always active.</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<h3><a href="#"><strong>HTML5 Number Selector</strong></a> <span class="xsmall">("Age" and "Discount" columns)</span></h3>
|
|
<div>
|
|
<ul>
|
|
<li>In <span class="version">v2.15.0</span> the <code>compare</code> option was updated to allow adding a selector along with the input. The <code>selected</code> option allows choosing the default setting.</li>
|
|
<li>This example shows how you can add an HTML5 number spinner to the filter column content.</li>
|
|
<li>The <code>filter_formatter</code> function provided in the extra "jquery.tablesorter.widgets-filter-formatter.js" file is used to add this custom control within the filter row.</li>
|
|
<li>Add the following code to apply an HTML spinner to filter a column:<pre class="prettyprint lang-javascript">$(function() {
|
|
|
|
$("table").tablesorter({
|
|
theme: 'blue',
|
|
// hidden filter input/selects will resize the columns, so try to minimize the change
|
|
widthFixed : true,
|
|
// initialize zebra striping and filter widgets
|
|
widgets: ["zebra", "filter"],
|
|
widgetOptions : {
|
|
// jQuery selector string of an element used to reset the filters
|
|
filter_reset : 'button.reset',
|
|
// add custom selector elements to the filter row
|
|
filter_formatter : {
|
|
|
|
// Age
|
|
3: function($cell, indx){
|
|
return $.tablesorter.filterFormatter.html5Number( $cell, indx, {
|
|
value: 1,
|
|
min: 1,
|
|
max: 65,
|
|
delayed: true,
|
|
addToggle: true,
|
|
exactMatch: true,
|
|
compare: ''
|
|
});
|
|
},
|
|
|
|
// Discount
|
|
5: function($cell, indx){
|
|
return $.tablesorter.filterFormatter.html5Number( $cell, indx, {
|
|
value: 1,
|
|
min: 1,
|
|
max: 44,
|
|
delayed: true,
|
|
addToggle: false,
|
|
compare: [ '<=', '=', '>=' ],
|
|
selected: 2
|
|
});
|
|
}
|
|
|
|
}
|
|
}
|
|
});
|
|
|
|
});</pre></li>
|
|
<li>This is spinner includes a toggle button. The toggle button is added by default, but if you don't want it, set the <code>addToggle</code> option to <code>false</code>. Without the toggle button, the filter is always active.</li>
|
|
<li>Another option named <code>exactMatch</code> was added to allow exact or general matching of column content.</li>
|
|
<li>A search delay option was added in v2.7.11 (time set by <code>filter_searchDelay</code> option). It can be disabled by setting the <code>delayed</code> option to <code>false</code>.</li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<h1>Demo</h1>
|
|
<button type="button" class="reset">Reset Search</button>
|
|
<div id="demo"><table class="tablesorter">
|
|
<thead>
|
|
<tr><th>Rank</th><th>Color</th><th>Name</th><th>Age</th><th>Total</th><th>Discount</th><th>Date</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr><td>1</td><td>#ff0000</td><td>Johnson</td><td>25</td><td>$5.95</td><td>22%</td><td>Jun 26, 2013 7:22 AM</td></tr>
|
|
<tr><td>11</td><td>#00ff00</td><td>Hibert</td><td>12</td><td>$2.99</td><td>5%</td><td>Aug 21, 2013 12:21 PM</td></tr>
|
|
<tr><td>12</td><td>#0000ff</td><td>Henry</td><td>51</td><td>$42.29</td><td>18%</td><td>Oct 13, 2013 1:15 PM</td></tr>
|
|
<tr><td>51</td><td>#00ff00</td><td>Parker</td><td>28</td><td>$9.99</td><td>20%</td><td>Jul 6, 2013 8:14 AM</td></tr>
|
|
<tr><td>21</td><td>#ffffff</td><td>Hood</td><td>33</td><td>$19.99</td><td>25%</td><td>Dec 10, 2012 5:14 AM</td></tr>
|
|
<tr><td>013</td><td>#ff0000</td><td>Kent</td><td>18</td><td>$15.89</td><td>44%</td><td>Jan 12, 2013 11:14 AM</td></tr>
|
|
<tr><td>005</td><td>#00ff00</td><td>Bruce</td><td>45</td><td>$153.19</td><td>44%</td><td>Jan 18, 2014 9:12 AM</td></tr>
|
|
<tr><td>10</td><td>#000000</td><td>Alex</td><td>3</td><td>$5.29</td><td>4%</td><td>Jan 8, 2013 5:11 PM</td></tr>
|
|
<tr><td>16</td><td>#ff0000</td><td>Franco</td><td>24</td><td>$14.19</td><td>14%</td><td>Jan 14, 2014 11:23 AM</td></tr>
|
|
<tr><td>66</td><td>#000000</td><td>Evans</td><td>22</td><td>$13.19</td><td>11%</td><td>Jan 18, 2013 9:12 AM</td></tr>
|
|
<tr><td>100</td><td>#ffffff</td><td>Brenda</td><td>18</td><td>$55.20</td><td>15%</td><td>Feb 12, 2013 7:23 PM</td></tr>
|
|
<tr><td>55</td><td>#000000</td><td>Bronson</td><td>65</td><td>$123.00</td><td>32%</td><td>Jan 20, 2014 1:12 PM</td></tr>
|
|
<tr><td>9</td><td>#000000</td><td>Martha</td><td>25</td><td>$22.09</td><td>17%</td><td>Jun 11, 2013 10:55 AM</td></tr>
|
|
</tbody>
|
|
</table></div>
|
|
|
|
<h1>Page Header</h1>
|
|
<div>
|
|
<pre class="prettyprint lang-html"><!-- jQuery UI for range slider -->
|
|
<link rel="stylesheet" href="css/jquery-ui.min.css">
|
|
<script src="js/jquery-ui.min.js"></script>
|
|
|
|
<!-- tablesorter plugin -->
|
|
<link rel="stylesheet" href="../css/theme.blue.css">
|
|
<script src="../js/jquery.tablesorter.js"></script>
|
|
<script src="../js/jquery.tablesorter.widgets.js"></script>
|
|
|
|
<!-- filter formatter code -->
|
|
<link rel="stylesheet" href="../css/filter.formatter.css">
|
|
<script src="../js/jquery.tablesorter.widgets-filter-formatter.js"></script></pre>
|
|
</div>
|
|
|
|
<h1>Javascript</h1>
|
|
<div id="javascript">
|
|
<pre class="prettyprint lang-javascript"></pre>
|
|
</div>
|
|
|
|
<h1>HTML</h1>
|
|
<div id="html">
|
|
<pre class="prettyprint lang-html"></pre>
|
|
</div>
|
|
|
|
<div class="next-up">
|
|
<hr />
|
|
Next up: <a href="example-widget-ui-theme.html">UITheme widget - jQuery UI theme ››</a>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</body>
|
|
</html>
|
|
|