jquery-tablesorter-filter
jquery-tablesorter-filter copied to clipboard
jbritten
A search/filter plugin which extends the jQuery TableSorter plugin
This tablesorterFilter plugin extends the jQuery TableSorter plugin (http://tablesorter.com), written by Christian Bach, and provides the ability to search the table and filter the results.
USAGE / EXAMPLE
Search:
| Last Name | First Name | Web Site | |
|---|---|---|---|
| Smith | John | [email protected] | http://www.jsmith.com |
| Doe | Jason | [email protected] | http://www.jdoe.com |
CONFIGURATION
tablesorterFilter takes up to six parameters:
* filterContainer - (optional) The DOM id of the input box where the user will type the search string. The default is "#filter-box".
* filterClearContainer - (optional) The DOM id of the button (or image, ...) which will clear the search string and reset the table to it's original, unfiltered state. The default is "#filter-clear-button".
* filterColumns - (optional) An array of columns, starting at 0, which will be searched. The default is null so all columns will be searched.
* filterCaseSensitive - (optional) Boolean stating whether the search string is case sensitive. The default is false.
* filterWaitTime - (optional) Time after last key press to start filtering. The default is 500 (milliseconds).
* filterFunction - (optional) Custom function to filter by column text. The default is the plugin function has_words.
* filterFromOriginal - (optional) Filter results from original list of rows. The default is false.
You may provide multiple filters, i.e.: .tablesorterFilter( { filterColumns: [0, 1] }, { filterContainer: "#filter-box-date", filterColumns: [2], filterFunction: filterByDate } ) Please note that you always have to use only one .tablesorterFilter() call, in this example with 2 object parameters.
Search words are separated by spaces, words with a leading dash will be excluded. Example: "include -exclude" will filter for all rows which do contain the (partitial) word "include" but at the same time do not contain the word "exclude".
You may filter programmatically: $("#filter-box").trigger("keyup").
REQUIREMENTS
jQuery version 1.2.1 or higher and a slightly modified jquery.tablesorter.js version 2.0.3. Both are included in this repo.
LICENSE
tablesorter_filter is (c) 2008 Justin Britten (justinbritten at gmail dot com) and is dual licensed under the MIT and GPL licenses.
jbritten