Fast search as you type jQuery-plugin
JavaScript HTML
Latest commit 61ce3ba Mar 19, 2015 @albburtsev npm public
Permalink
Failed to load latest commit information.
dist New file tree Feb 27, 2015
html New file tree Feb 27, 2015
screenshots
src New file tree Feb 27, 2015
.jscs.json Adds Gruntfile.js, fixes #3 Apr 24, 2014
.jshintrc New jshint config Dec 8, 2014
Gruntfile.js New file tree Feb 27, 2015
LICENSE Initial commit Jan 20, 2014
README.md Tweak Readme. Dec 9, 2014
README.ru.md Callback onFound() Dec 8, 2014
bower.json v0.0.8 Feb 27, 2015
package.json npm public Mar 19, 2015

README.md

jquery.lookingfor

Screenshot

Fast search as you type jQuery plugin.

It's very small (minified — 2.5kb, gzipped — 1.2kb), very fast and supports old browsers (IE6+).

jquery.lookingfor plugin searches text in list items (<li>) and hides unmatched items. It works not only for <li>s, but for any HTML element on a page. Any input field (input, textarea) can be transformed to search filter with jquery.lookingfor.

Live demo

Install

Download latest release. Use minified or development version.

Or use bower for install:

bower install jquery.lookingfor --save

Usage

Include jQuery and jquery.lookingfor on your page:

<script src="http://code.jquery.com/jquery-1.10.2.min.js"></script>
<script src="jquery.lookingfor.js"></script>

Prepare list of items for following search and an input field (optional):

<input type="search" name="query" />
<ul id="numerals">
	<li>First</li>
	<li>Second</li>
	<li>Third</li>
	...
</ul>

Call lookingfor() method with necessary options:

jQuery(function($) {
	$('#numerals').lookingfor({
		input: $('input[name="query"]'),
		items: 'li'
	});
});

Options

All options are optional.

  • input — input field's selector;
  • items — item's selector, default – 'li';
  • highlight — set true to highlight matched text, default — false;
  • highlightColor#RRGGBB background color for matched text, default – #FFDE00;
  • onFound {Function(HTMLElement item, String query)} — callback, will be called when text is found.