Skip to content

Latest commit

 

History

History
114 lines (89 loc) · 3.79 KB

README.md

File metadata and controls

114 lines (89 loc) · 3.79 KB
Raw

HideSeek-Mod

npm npm version cdn version

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.

Features

  • Search in text or title/alt attribute
  • Highlight
  • Navigation
  • Ignore elements
  • Ignore accented characters
  • Custom events
  • Custom messages
  • Hidden mode
  • Support lists with headings
  • Throttling

Compatibility

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.

CDN

Served using:

Credits

Changelog

v0.8.5

  • Fix: Don't show no-results message on empty query and hidden-mode

v0.8.4

  • Wildcard search (use '*' in queries)

v0.8.3

  • Fix: Improved query change handling
  • Generating map file

v0.8.2

  • Fix: Ignore accents on query
  • Slovak accents support
  • Polish accents support

v0.8.1

  • Throttling - delayed search with cancellation if the next keystroke arrives

Development

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).

npm install

To generate bundles and copy them in all required places use the following command.

npm run build

Testing

Use index.html page to test your code locally.

docs/index.html

Pull request

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

http://www.apache.org/licenses/LICENSE-2.0

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.