As of v2.4, an <i> element, with this class name, is automatically appended to the header cells. To prevent the plugin from adding an <i> element to the headers, set the
cssIcon option to an empty string.
@@ -743,7 +744,7 @@
headerTemplate |
String |
'{content}' |
-
This is a template string which allows adding additional content to the header while it is being built. New! v2.7.
+ | This is a template string which allows adding additional content to the header while it is being built (v2.7).
This template string has two modifying tags: {content} and {icon}.
{content} will be replaced by the current header HTML content.
@@ -814,7 +815,7 @@
Function |
null |
- This function is called after the template string has been built, but before the template string is applied to the header and before the onRenderHeader function is called. New! v2.7.
+ This function is called after the template string has been built, but before the template string is applied to the header and before the onRenderHeader function is called (v2.7).
The onRenderTemplate function receives a column index and template string parameters. The template string, from the headerTemplate option, will already have the {icon} and {content} tags replaced; it's just a string of formatted HTML. When done manipulating this string, return it. Here is an example:
@@ -1604,7 +1605,7 @@ $(function(){
Object |
null |
- Filter widget: This option allows you to add custom controls within the filter widget row. New! v2.7.7
+ Filter widget: This option allows you to add custom controls within the filter widget row (v2.7.7).
A new file has been included named "jquery.tablesorter.widgets-filter-formatter.js". It includes code to add jQuery UI and HTML5 controls via the filter_formatter option.
@@ -1796,6 +1797,20 @@ $(function(){
Example |
+
+ | filter_liveSearch |
+ Boolean |
+ true |
+
+ Filter widget: Search the column content as the user types, with the delay set in the filter_searchDelay option New! v2.9.
+
+
+ This option allows you to disable the live search behavior so that a filter is only applied when the user presses enter (or uses escape to clear and cancel the search).
+
+ |
+ |
+
+
| filter_reset |
String |
@@ -2820,7 +2835,7 @@ or, directly add the search string to the filter input as follows:
| filterReset |
- Trigger the filter widget to reset the search criteria. New! v2.7.7.
+ | Trigger the filter widget to reset the search criteria (v2.7.7).
If you are using the filter_formatter option to add custom input elements, this function may not work on those columns. Please refer to the filter_formatter section for more details.
$(function(){
@@ -2834,7 +2849,7 @@ or, directly add the search string to the filter input as follows:
| saveSortReset |
- Trigger the saveSort widget to clear any saved sorts for that specific table. New! v2.7.11.
+ | Trigger the saveSort widget to clear any saved sorts for that specific table (v2.7.11).
$(function(){
$('button').click(function(){
@@ -2853,7 +2868,7 @@ or, directly add the search string to the filter input as follows:
| pageSize |
- Trigger the pager to change the page size. New! v2.7.4.
+ | Trigger the pager to change the page size (v2.7.4).
$(function(){
$('table').trigger('pageSize', 15);
@@ -2863,7 +2878,7 @@ or, directly add the search string to the filter input as follows:
| pageSet |
- Trigger the pager to change the current page. New! v2.7.7.
+ | Trigger the pager to change the current page (v2.7.7).
$(function(){
$('table').trigger('pageSet', 3);
diff --git a/js/jquery.tablesorter.widgets.js b/js/jquery.tablesorter.widgets.js
index c4c8bd1b..f4e530a7 100644
--- a/js/jquery.tablesorter.widgets.js
+++ b/js/jquery.tablesorter.widgets.js
@@ -291,6 +291,7 @@ ts.addWidget({
filter_functions : null, // add custom filter functions using this option
filter_hideFilters : false, // collapse filter row when mouse leaves the area
filter_ignoreCase : true, // if true, make all searches case-insensitive
+ filter_liveSearch : true, // if true, search column content while the user types (with a delay)
filter_reset : null, // jQuery selector string of an element used to reset the filters
filter_searchDelay : 300, // typing delay in milliseconds before starting a search
filter_startsWith : false, // if true, filter start from the beginning of the cell contents
@@ -585,7 +586,7 @@ ts.addWidget({
})
.find('input.' + css).bind('keyup search', function(e, filter){
// ignore arrow and meta keys; allow backspace
- if (e.type === 'keyup' && ((e.which < 32 && e.which !== 8) || (e.which >= 37 && e.which <=40))) { return; }
+ if (e.type === 'keyup' && ((e.which < 32 && e.which !== 8) || (e.which >= 37 && e.which <=40) || (e.which !== 13 && !wo.filter_liveSearch))) { return; }
// skip delay
if (typeof filter !== 'undefined' && filter !== true){
checkFilters(filter);
| | | | | | |