Skip to content

Simple jQuery plugin for search suggests with local cache

License

Notifications You must be signed in to change notification settings

AlexPavlof/suggestable

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

jquery-suggestable

Simple jQuery plugin implementing search suggests with local cache.

Usage

$('selector').suggestable({
    'data-url'          : 'object\'s data-property which contains url to suggests',
    'container-class'   : 'css class name for drop-down <ul>',
    'item-class'        : 'css class name for each suggest <li> item',
    'item-active-class' : 'css class name for active suggest <li> item',
    'term-class'        : 'css class name for term part of each suggest item',
    'suggest-class'     : 'css class name for suggest part of each suggest item',
    'delimiter-text'    : 'text for delimiter between term and text parts',
    'delimiter-class'   : 'css class name for delimiter between term and text parts',
    'text-class'        : 'css class name for text part of each suggest item',
    'term-min-length'   : 'minimum length required to trigger request'
});

Provides events

$(document).trigger('suggestable-show', [$container]);     // Suggestable container is shown
$(document).trigger('suggestable-hide', [$container]);     // Suggestable container is hidden
$(document).trigger('suggestable-click', [$container]);    // Suggestable item is clicked
$(document).trigger('suggestable-item-select', [$item]);   // Suggestable item is selected
$(document).trigger('suggestable-item-unselect', [$item]); // Suggestable item is unselected

About

Simple jQuery plugin for search suggests with local cache

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%