Skip to content
A live filter plugin for jQuery that is built for speed and ease of use.
JavaScript
Find file
Pull request Compare This branch is 5 commits behind awbush:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
.gitignore
CHANGELOG.md
LICENSE.txt
README.md
jquery.fastLiveFilter.js
package.json

README.md

What

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.

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.

Something went wrong with that request. Please try again.