A simple, yet customizable quick/live search jQuery plugin.
This is a forked and extended version of the original library. The original project seems to be dead for a while (2 years now) and author is not responsive. Aim of this fork is to keep it active and open for new features and fixes.
- Search in text or title/alt attribute
- Ignore elements
- Ignore accented characters
- Custom events
- Custom messages
- Hidden mode
- Support lists with headings
Compatible with IE7+, Chrome, Firefox, Safari and jQuery 1.8.x, 1.9.x, 1.11.x, 1.12.x, 2.1.x, 2.2.x.
Questions/Answers and Enhancements
Do you have any questions? First, take a look here.
Or if you are looking for enhancements, here.
- Fix: Don't show no-results message on empty query and hidden-mode
- Wildcard search (use '*' in queries)
- Fix: Improved query change handling
- Generating map file
- Fix: Ignore accents on query
- Slovak accents support
- Polish accents support
- Throttling - delayed search with cancellation if the next keystroke arrives
To test your changes and prepare pull request you need to update bundles. The easiest way to do it is via build script.
First you need to install node dependencies (trying to keep low number of them - currently 3 are being installed).
To generate bundles and copy them in all required places use the following command.
npm run build
Use index.html page to test your code locally.
Before sending PR make sure your change is not breaking any functionality. Please test all of the features carefully.
If you add a new functionality please update index.html and add the new secion for it.
Copyright and license
Copyright 2015 Dimitris Krestos
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.