jQuery Fast Live Filter

This is a live filter plugin for jQuery that is built for speed and ease of use. It was made because existing tools were inadequate (too slow, wrong feature set). Check out the demo and comparison pages.

Download

Get the code on github. Latest release is 1.0.3 (see all releases). If you just want the latest JavaScript file right now, get it here.

This software is released under the FreeBSD 2-clause License. (You can use it for free on your personal and commercial projects.)

Usage

Include jQuery, the plugin, then initialize the plugin:

<script src="jquery-1.6.4.min.js"></script>
<script src="jquery.fastLiveFilter.js"></script>
<script>
    $(function() {
        $('#search_input').fastLiveFilter('#search_list');
    });
</script>

The above would work with this HTML:

<input id="search_input" placeholder="Type to filter">
<ul id="search_list">
    <li>One</li>
    <li>Two</li>
    <li>Three</li>
</ul>

Options

Options are given as the second argument. Synopsis:

$(INPUT_SELECTOR).fastLiveFilter(LIST_SELECTOR, options);

Available options:

  • timeout: How many milliseconds to wait after keydown before filtering the list. Default is 0.
  • callback: A callback method which will be given the number of items left in the list.

Example:

$('#search_input').fastLiveFilter('#search_list', {
    timeout: 200,
    callback: function(total) { $('#num_results').html(total); }
});

Problems? Want to contribute?

Report issues on github. Use pull requests to contribute code. Versioning will be done as defined by Semantic Versioning.