Notes

Hover over the grey bar below the table header to open the filter row. Disable this by setting filter_hideFilters option to false.
This widget uses jQuery's .nextUntil() function which is only available is jQuery version 1.4+.
This widget does work with tablesorter v2.0.5.

Using the filters:

Type (1)	Description	Examples
text	Any text entered in the filter will match text found within the column	`abc` (finds "abc", "abcd", "abcde", etc); (finds "Aaron" and "Philip Aaron Wong")
`~`	Fuzzy search (matches sequential characters) the query by adding a tilde to the beginning of the query (New v2.13.3)	(matches "Bruce Lee" and "Brenda Dexter") or (matches "Philip Aaron Wong")
`"`	To exactly match the search query, add a quote, apostrophe or equal sign to the beginning and/or end of the query	`abc"` or `abc=` (exactly match "abc"); or (exactly match "John")
`?`	Wildcard for a single, non-space character.	`J?n` (finds "Jan" and "Jun", but not "Joan"); (finds "Dumass" and "Evans", but not "McMasters")
`*`	Wildcard for zero or more non-space characters.	`B*k` (matches "Black" and "Book"); (matches "Dumass", "Evans" and "McMasters")
`/\d/`	Add any regex to the query to use in the query	`/b[aeiou]g/i` (finds "bag", "beg", "BIG", "Bug", etc); (matches text that ends with an "r")
`< <= >= >`	Find alphabetical or numerical values less than or greater than or equal to the filtered query (2).	(find values greater than or equal to 10)
`!`	Not operator. Filter the column with content that do not match the query.	`!fe` (hide rows with "female" in that column, but shows rows with "male"); (find text that doesn't contain an "a")
`&&` or `AND`	Logical "and". Filter the column for content that matches text from either side of the operator.	`box && bat` (matches a column cell that contains both "box" and "bat"); (Find text that contains both "br" and "c")
`\|` or `OR`	Logical "or" (Vertical bar). Filter the column for content that matches text from either side of the bar (3).	`box\|bat` (matches a column cell with either "box" or "bat"); (Find text that contains either "Alex" or "Peter")
`-` or `to`	Find a range of values. Make sure there is a space before and after the dash (or the word "to") (2).	or (match values between 10 and 30)

(1) You cannot combine these operators with each other (except for the wildcards).
(2) In tablesorter v2.10, comparisons can be made in date columns (if properly parsed).
(3) Logical "or" comparisons can now show exact matches (by default; v2.10.1) or just match cell contents.

Options

Filter widget defaults (added inside of tablesorter `widgetOptions`)

filter_anyMatch : false - if true, a match in any column will show the row (see the demo for exceptions).
filter_childRows : false - if true, filter includes child row content in the search.
filter_columnFilters : true - if true, a filter will be added to the top of each table column.
filter_cssFilter : '' - extra css class name added to the filter row & each input in the row.
filter_defaultAttrib : 'data-value' - this option contains the name of the data-attribute which contains the default (starting) filter value.
filter_filteredRow : 'filtered' - css class name added to filtered rows (rows that are not showing); needed by pager plugin.
filter_formatter : null - add custom filter elements to the filter row.
filter_functions : null - add custom filter functions using this option.
filter_hideFilters : false - if true, filters are hidden initially, but can be revealed by clicking on the filter icon *.
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). If false, the user must press enter to start the search. If set to a number, when the length of the input text reaches this minimum length, a search will initiate.
filter_onlyAvail : 'filter-onlyAvail' - a header with a select dropdown & this class name will only show available (visible) options within that drop down.
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_serversideFiltering : false - if true, filter will be done server-side. The client-side filtering will be disabled, but the ui and events will still be used.
filter_startsWith : false - if true, filter start from the beginning of the cell contents.
filter_useParsedData : false - filter all data using parsed content.

Classes

Class names that can be added to the th header cells:

filter-false - disable the filter for a specific header column.
filter-select - build a default select box for a column (shows unique column content). See the custom filter widget demo for an example.
filter-match - applies to "filter-select" columns and columns where the user can use the logical "or" search. Makes the filter/select match the column contents instead of exactly matching.
filter-parsed - set a column to filter through parsed data instead of the actual table cell content.
filter-onlyAvail - show only available (visible) options within a default select box. See the custom filter widget demo "Discount" column for an example.

Methods

filterReset

Use the filterReset method to reset (clear) all of the current filters using this method
$('table').trigger('filterReset');

search

With this method, you can pass an array of filter values:
// apply "2?%" filter to the fifth column (zero-based index)
var columns = [];
columns[5] = '2?%';
// or define the array this way var columns = [ '', '', '', '', '', '2?%' ]
$('table').trigger('search', [ columns ]);
or, just pass false to refresh the current search:
$('table').trigger('search', false);
* Note: using this search method will not update the contents of the filters within the filter row; use the $.tablesorter.setFilter() method below to do that.

Get current filters

Get an array of the currently applied filters (v2.9).
$.tablesorter.getFilters( $('table') ); // or $('table.hasFilters')
This method returns an array of filter values or false if the selected table does not contain a filter row.

Set current filters

Set the values of the actual filters using this method; include a true boolean to actually apply the search (v2.9).
// update filters, but don't apply the search
$.tablesorter.setFilters( $('table'), [ '', '', '', '', '', '2?%' ] );

// update filters, AND apply the search
$.tablesorter.setFilters( $('table'), [ '', '', '', '', '', '2?%' ], true );
This method returns true if the filters were sucessfully applied, or false if the table does have a filter row.

Bind External filter

Use this method in conjunction with the filter_anyMatch option (set to true (New v2.13.3).

// Target the $('.search') input using built in functioning
// this binds to the search using "search" and "keyup"
// Allows using filter_liveSearch or delayed search &
// pressing escape to cancel the search
$.tablesorter.filter.bindSearch( $table, $('.search') );

If you don't care about the enhanced search filter, then bind to both the "keyup" and "search" events

// Basic search binding, alternate to the above
// bind to search - pressing enter and clicking on "x" to clear (Webkit)
// keyup allows dynamic searching
$(".search").bind('search keyup', function (e) {
  $('table').trigger('search', [ [this.value] ]);
});

Events

Changes

Demo

filter_startsWith : false (if true, search from beginning of cell content only)
filter_ignoreCase : true (if false, the search will be case sensitive)
filter-match (if class name added to the "First Name" column, all "or" searches will only match the content; Search in the First Name column (2.10.1).

(search the Discount column for "2?%")

Rank	First Name ( filter-match )	Last Name	Age	Total	Discount	Date

1	Philip Aaron Wong	Johnson Sr Esq	25	$5.95	22%	Jun 26, 2004 7:22 AM
11	Aaron	Hibert	12	$2.99	5%	Aug 21, 2009 12:21 PM
12	Brandon Clark	Henry Jr	51	$42.29	18%	Oct 13, 2000 1:15 PM
111	Peter	Parker	28	$9.99	20%	Jul 6, 2006 8:14 AM
21	John	Hood	33	$19.99	25%	Dec 10, 2002 5:14 AM
013	Clark	Kent Sr.	18	$15.89	44%	Jan 12, 2003 11:14 AM
005	Bruce	Almighty Esq	45	$153.19	44%	Jan 18, 2021 9:12 AM
10	Alex	Dumass	13	$5.29	4%	Jan 8, 2012 5:11 PM
16	Jim	Franco	24	$14.19	14%	Jan 14, 2004 11:23 AM
166	Bruce Lee	Evans	22	$13.19	11%	Jan 18, 2007 9:12 AM
100	Brenda Dexter	McMasters	18	$55.20	15%	Feb 12, 2010 7:23 PM
55	Dennis	Bronson	65	$123.00	32%	Jan 20, 2001 1:12 PM
9	Martha	delFuego	25	$22.09	17%	Jun 11, 2011 10:55 AM

Page Header

<!-- blue theme stylesheet -->
<link rel="stylesheet" href="../css/theme.blue.css">
<!-- tablesorter plugin -->
<script src="../js/jquery.tablesorter.js"></script>

<!-- tablesorter widget file - loaded after the plugin -->
<script src="../js/jquery.tablesorter.widgets.js"></script>

Javascript

$(function() {

  // call the tablesorter plugin
  $("table.tablesorter").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"],

    // headers: { 5: { sorter: false, filter: false } },

    widgetOptions : {

      // If there are child rows in the table (rows with class name from "cssChildRow" option)
      // and this option is true and a match is found anywhere in the child row, then it will make that row
      // visible; default is false
      filter_childRows : false,

      // if true, a filter will be added to the top of each table column;
      // disabled by using -> headers: { 1: { filter: false } } OR add class="filter-false"
      // if you set this to false, make sure you perform a search using the second method below
      filter_columnFilters : true,

      // extra css class applied to the table row containing the filters & the inputs within that row
      filter_cssFilter : '',

      // class added to filtered rows (rows that are not showing); needed by pager plugin
      filter_filteredRow   : 'filtered',

      // add custom filter elements to the filter row
      // see the filter formatter demos for more specifics
      filter_formatter : null,

      // add custom filter functions using this option
      // see the filter widget custom demo for more specifics on how to use this option
      filter_functions : null,

      // if true, filters are collapsed initially, but can be revealed by hovering over the grey bar immediately
      // below the header row. Additionally, tabbing through the document will open the filter row when an input gets focus
      filter_hideFilters : true,

      // Set this option to false to make the searches case sensitive
      filter_ignoreCase : true,

      // if true, search column content while the user types (with a delay)
      filter_liveSearch : true,

      // jQuery selector string of an element used to reset the filters
      filter_reset : 'button.reset',

      // Delay in milliseconds before the filter widget starts searching; This option prevents searching for
      // every character while typing and should make searching large tables faster.
      filter_searchDelay : 300,

      // if true, server-side filtering should be performed because client-side filtering will be disabled, but
      // the ui and events will still be used.
      filter_serversideFiltering: false,

      // Set this option to true to use the filter to find text from the start of the column
      // So typing in "a" will find "albert" but not "frank", both have a's; default is false
      filter_startsWith : false,

      // Filter using parsed content for ALL columns
      // be careful on using this on date columns as the date is parsed and stored as time in seconds
      filter_useParsedData : false

    }

  });

  // External search
  // buttons set up like this:
  // <button type="button" data-filter-column="4" data-filter-text="2?%">Saved Search</button>
  $('button[data-filter-column]').click(function(){
    /*** first method *** data-filter-column="1" data-filter-text="!son"
      add search value to Discount column (zero based index) input */
    var filters = [],
      $t = $(this),
      col = $t.data('filter-column'), // zero-based index
      txt = $t.data('filter-text') || $t.text(); // text to add to filter

    filters[col] = txt;
    // using "table.hasFilters" here to make sure we aren't targetting a sticky header
    $.tablesorter.setFilters( $('table.hasFilters'), filters, true ); // new v2.9

    /** old method (prior to tablsorter v2.9 ***
    var filters = $('table.tablesorter').find('input.tablesorter-filter');
    filters.val(''); // clear all filters
    filters.eq(col).val(txt).trigger('search', false);
    ******/

    /*** second method ***
      this method bypasses the filter inputs, so the "filter_columnFilters"
      option can be set to false (no column filters showing)
    ******/
    /*
    var columns = [];
    columns[5] = '2?%'; // or define the array this way [ '', '', '', '', '', '2?%' ]
    $('table').trigger('search', [ columns ]);
    */

    return false;
  });

});

CSS

/* filter row */
.tablesorter-filter-row td {
  background: #eee;
  line-height: normal;
  text-align: center; /* center the input */
  -webkit-transition: line-height 0.1s ease;
  -moz-transition: line-height 0.1s ease;
  -o-transition: line-height 0.1s ease;
  transition: line-height 0.1s ease;
}
/* optional disabled input styling */
.tablesorter-filter-row .disabled {
  opacity: 0.5;
  filter: alpha(opacity=50);
  cursor: not-allowed;
}

/* hidden filter row */
.tablesorter-filter-row.hideme td {
  /*** *********************************************** ***/
  /*** change this padding to modify the thickness     ***/
  /*** of the closed filter row (height = padding x 2) ***/
  padding: 2px;
  /*** *********************************************** ***/
  margin: 0;
  line-height: 0;
  cursor: pointer;
}
.tablesorter-filter-row.hideme .tablesorter-filter {
  height: 1px;
  min-height: 0;
  border: 0;
  padding: 0;
  margin: 0;
  /* don't use visibility: hidden because it disables tabbing */
  opacity: 0;
  filter: alpha(opacity=0);
}

/* filters */
.tablesorter-filter {
  width: 95%;
  height: inherit;
  margin: 4px;
  padding: 4px;
  background-color: #fff;
  border: 1px solid #bbb;
  color: #333;
  -webkit-box-sizing: border-box;
  -moz-box-sizing: border-box;
  box-sizing: border-box;
  -webkit-transition: height 0.1s ease;
  -moz-transition: height 0.1s ease;
  -o-transition: height 0.1s ease;
  transition: height 0.1s ease;
}

HTML


  <button type="button" data-filter-column="5" data-filter-text="2?%">Saved Search</button> (search the Discount column for "2?%")<br>
  <button type="button" class="reset">Reset Search</button> <!-- targeted by the "filter_reset" option -->

  <table class="tablesorter">
  <thead>
    <tr>
      <!-- you can also add a placeholder using script; $('.tablesorter th:eq(0)').data('placeholder', 'hello') -->
      <th data-placeholder="" class="filter-false">Rank</th>
      <th data-placeholder="Try B*{space} or alex|br*|c" class="filter-match">First Name (<span></span> filter-match )</th>
      <th data-placeholder="Try <d">Last Name</th>
      <th data-placeholder="Try >=33">Age</th>
      <th data-placeholder="Try <9.99">Total</th>
      <th data-placeholder="Try 2?%">Discount</th> <!-- add class="filter-false" to disable the filter in this column -->
      <th data-placeholder="Try /20[^0]\d/ or >1/1/2010">Date</th>
    </tr>
  </thead>
  <tbody>
    <tr><td>1</td><td>Philip Aaron Wong</td><td>Johnson Sr Esq</td><td>25</td><td>$5.95</td><td>22%</td><td>Jun 26, 2004 7:22 AM</td></tr>
    <tr><td>11</td><td>Aaron</td><td>Hibert</td><td>12</td><td>$2.99</td><td>5%</td><td>Aug 21, 2009 12:21 PM</td></tr>
    <tr><td>12</td><td>Brandon Clark</td><td>Henry Jr</td><td>51</td><td>$42.29</td><td>18%</td><td>Oct 13, 2000 1:15 PM</td></tr>
    <tr><td>111</td><td>Peter</td><td>Parker</td><td>28</td><td>$9.99</td><td>20%</td><td>Jul 6, 2006 8:14 AM</td></tr>
    <tr><td>21</td><td>John</td><td>Hood</td><td>33</td><td>$19.99</td><td>25%</td><td>Dec 10, 2002 5:14 AM</td></tr>
    <tr><td>013</td><td>Clark</td><td>Kent Sr.</td><td>18</td><td>$15.89</td><td>44%</td><td>Jan 12, 2003 11:14 AM</td></tr>
    <tr><td>005</td><td>Bruce</td><td>Almighty Esq</td><td>45</td><td>$153.19</td><td>44%</td><td>Jan 18, 2021 9:12 AM</td></tr>
    <tr><td>10</td><td>Alex</td><td>Dumass</td><td>13</td><td>$5.29</td><td>4%</td><td>Jan 8, 2012 5:11 PM</td></tr>
    <tr><td>16</td><td>Jim</td><td>Franco</td><td>24</td><td>$14.19</td><td>14%</td><td>Jan 14, 2004 11:23 AM</td></tr>
    <tr><td>166</td><td>Bruce Lee</td><td>Evans</td><td>22</td><td>$13.19</td><td>11%</td><td>Jan 18, 2007 9:12 AM</td></tr>
    <tr><td>100</td><td>Brenda Dexter</td><td>McMasters</td><td>18</td><td>$55.20</td><td>15%</td><td>Feb 12, 2010 7:23 PM</td></tr>
    <tr><td>55</td><td>Dennis</td><td>Bronson</td><td>65</td><td>$123.00</td><td>32%</td><td>Jan 20, 2001 1:12 PM</td></tr>
    <tr><td>9</td><td>Martha</td><td>delFuego</td><td>25</td><td>$22.09</td><td>17%</td><td>Jun 11, 2011 10:55 AM</td></tr>
  </tbody>
</table>

Next up: jQuery Any Match filter widget ››

tablesorter

Filter Widget

Flexible client-side table sorting

Notes

Options

Filter widget defaults (added inside of tablesorter `widgetOptions`)

Classes

Methods

filterReset

search

Get current filters

Set current filters

Bind External filter

Events

Changes

Demo

Page Header

Javascript

CSS

HTML

tablesorter

Filter Widget

Flexible client-side table sorting

Notes

Options

Filter widget defaults (added inside of tablesorter widgetOptions)

Classes

Methods

filterReset

search

Get current filters

Set current filters

Bind External filter

Events

Changes

Demo

Page Header

Javascript

CSS

HTML

Filter widget defaults (added inside of tablesorter `widgetOptions`)