jQuery Filter Table Plugin

This plugin will add a search filter to tables. When typing in the filter, any rows that do not contain the filter will be hidden.

One can also define clickable shortcuts for commonly used terms.

See the demos at http://sunnywalker.github.com/jQuery.FilterTable

Usage

Include the dependencies:

<script src="/path/to/jquery.js"></script>
<script src="/path/to/bindWithDelay.js"></script> <!-- optional -->
<script src="/path/to/jquery.filtertable.js"></script>
<style>
.filter-table .quick { margin-left: 0.5em; font-size: 0.8em; text-decoration: none; }
.fitler-table .quick:hover { text-decoration: underline; }
td.alt { background-color: #ffc; background-color: rgba(255, 255, 0, 0.2); }
</style> <!-- or put the styling in your stylesheet -->

Then apply filterTable() to your table(s):

<script>
$('table').filterTable(); //if this code appears after your tables; otherwise, include it in your document.ready() code.
</script>

Problems?

Be sure to check the FAQ file for common issues if the plugin does not seem to be working as intended.

Note that the plugin does not work as expected when using cells with rowspan.

Options

Option	Type	Default	Description
autofocus	boolean	false	Makes the filter input field autofocused (not recommended for accessibility reasons)
callback	function(term, table)	null	Callback function after a filter is performed. Parameters: term filter term (string) table table being filtered (jQuery object)
containerClass	string	filter-table	Class applied to the main filter input container
containerTag	string	p	Tag name of the main filter input container
hideTFootOnFilter	boolean	false	Controls whether the table's tfoot(s) will be hidden when the table is filtered
highlightClass	string	alt	Class applied to cells containing the filter term
ignoreClass	string	''	Ignore any cells with this class when filtering
ignoreColumns	array	[]	Ignore these columns (0-indexed) when filtering
inputSelector	string	null	Use this selector to find the filter input instead of creating a new one (only works if selector returns a single element)
inputName	string	filter-table	Name attribute of the filter input field
inputType	string	search	Tag name of the filter input itself
label	string	Filter:	Text to precede the filter input
minChars	integer	1	Filter only when at least this number of characters are in the filter input field
minRows	integer	8	Only show the filter on tables with this number of rows or more
placeholder	string	search this table	HTML5 placeholder text for the filter input
preventReturnKey	boolean	true	Trap the return key in the filter input field to prevent form submission
quickList	array	[]	List of clickable phrases to quick fill the search
quickListClass	string	quick	Class of each quick list item
quickListClear	string	''	Label for the clear filtering quick list item (or none if blank)
quickListGroupTag	string	''	Tag name surrounding quick list items (e.g., ul)
quickListTag	string	a	Tag name of each quick list item (e.g., a or li)
visibleClass	string	visible	Class applied to visible rows

Styling

Suggested styling:

.filter-table .quick { margin-left: 0.5em; font-size: 0.8em; text-decoration: none; }
.fitler-table .quick:hover { text-decoration: underline; }
td.alt { background-color: #ffc; background-color: rgba(255, 255, 0, 0.2); }

There is a caveat on automatic row striping. While alternating rows can be striped with CSS, such as:

tbody td:nth-child(even) { background-color: #f0f8ff; }

Note that CSS cannot differentiate between visible and non-visible rows. To that end, it's better to use jQuery to add and remove a striping class to visible rows by defining a callback function in the options.

$('table').filterTable({
    callback: function(term, table) {
        table.find('tr').removeClass('striped').filter(':visible:even').addClass('striped');
    }
});

Dependencies

Other than jQuery, the plugin will take advantage of Brian Grinstead's bindWithDelay if it is available.

License

(The MIT License)

Copyright (c) 2012 Sunny Walker swalker@hawaii.edu

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.