jQuery plugin: Tablesorter 2.0 - Filter Widget

# tablesorter

## Filter Widget

### Flexible client-side table sorting

Back to documentation

### Notes

- Added & set `filter_saveFilters` to `true` (default is `false`) in this demo (v2.14).
- 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 (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_saveFilters : false` - Uses the `$.tablesorter.storage` utility to save the most recent 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` (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

- `filterEnd` - Event triggered when the filter widget has finished processing the search.
- `filterInit` - Event triggered when the filter widget has finished initializing.
- `filterStart` - Event triggered when the filter widget has started processing the search.

### Changes

Moved to the wiki pages - filter change log.

# 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
in the Discount column

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

# 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

Next up: jQuery Any Match filter widget ››