2 * Autocomplete - jQuery plugin 1.1pre
4 * Copyright (c) 2007 Dylan Verheul, Dan G. Switzer, Anjesh Tuladhar, Jörn Zaefferer
6 * Dual licensed under the MIT and GPL licenses:
7 * http://www.opensource.org/licenses/mit-license.php
8 * http://www.gnu.org/licenses/gpl.html
10 * Revision: $Id: jquery.autocomplete.js 5785 2008-07-12 10:37:33Z joern.zaefferer $
17 autocomplete: function(urlOrData, options) {
18 var isUrl = typeof urlOrData == "string";
19 options = $.extend({}, $.Autocompleter.defaults, {
20 url: isUrl ? urlOrData : null,
21 data: isUrl ? null : urlOrData,
22 delay: isUrl ? $.Autocompleter.defaults.delay : 10,
23 max: options && !options.scroll ? 10 : 150
26 // if highlight is set to false, replace it with a do-nothing function
27 options.highlight = options.highlight || function(value) { return value; };
29 // if the formatMatch option is not specified, then use formatItem for backwards compatibility
30 options.formatMatch = options.formatMatch || options.formatItem;
32 return this.each(function() {
33 new $.Autocompleter(this, options);
36 result: function(handler) {
37 return this.bind("result", handler);
39 search: function(handler) {
40 return this.trigger("search", [handler]);
42 flushCache: function() {
43 return this.trigger("flushCache");
45 setOptions: function(options){
46 return this.trigger("setOptions", [options]);
48 unautocomplete: function() {
49 return this.trigger("unautocomplete");
53 $.Autocompleter = function(input, options) {
68 // Create $ object for input element
69 var $input = $(input).attr("autocomplete", "off").addClass(options.inputClass);
72 var previousValue = "";
73 var cache = $.Autocompleter.Cache(options);
77 mouseDownOnSelect: false
79 var select = $.Autocompleter.Select(options, input, selectCurrent, config);
83 // prevent form submit in opera when selecting with return key
84 $.browser.opera && $(input.form).bind("submit.autocomplete", function() {
91 // only opera doesn't trigger keydown multiple times while pressed, others don't work with keypress at all
92 $input.bind(($.browser.opera ? "keypress" : "keydown") + ".autocomplete", function(event) {
93 // track last key pressed
94 lastKeyPressCode = event.keyCode;
95 switch(event.keyCode) {
98 event.preventDefault();
99 if ( select.visible() ) {
107 event.preventDefault();
108 if ( select.visible() ) {
116 event.preventDefault();
117 if ( select.visible() ) {
125 event.preventDefault();
126 if ( select.visible() ) {
133 // matches also semicolon
134 case options.multiple && $.trim(options.multipleSeparator) == "," && KEY.COMMA:
137 if( selectCurrent() ) {
138 // stop default to prevent a form submit, Opera needs special handling
139 event.preventDefault();
150 clearTimeout(timeout);
151 timeout = setTimeout(onChange, options.delay);
155 // track whether the field has focus, we shouldn't process any
156 // results if the field no longer has focus
160 if (!config.mouseDownOnSelect) {
163 }).click(function() {
164 // show select when clicking in a focused field
165 if ( hasFocus++ > 1 && !select.visible() ) {
168 }).bind("search", function() {
169 // TODO why not just specifying both arguments?
170 var fn = (arguments.length > 1) ? arguments[1] : null;
171 function findValueCallback(q, data) {
173 if( data && data.length ) {
174 for (var i=0; i < data.length; i++) {
175 if( data[i].result.toLowerCase() == q.toLowerCase() ) {
181 if( typeof fn == "function" ) fn(result);
182 else $input.trigger("result", result && [result.data, result.value]);
184 $.each(trimWords($input.val()), function(i, value) {
185 request(value, findValueCallback, findValueCallback);
187 }).bind("flushCache", function() {
189 }).bind("setOptions", function() {
190 $.extend(options, arguments[1]);
191 // if we've updated the data, repopulate
192 if ( "data" in arguments[1] )
194 }).bind("unautocomplete", function() {
197 $(input.form).unbind(".autocomplete");
201 function selectCurrent() {
202 var selected = select.selected();
206 var v = selected.result;
209 if ( options.multiple ) {
210 var words = trimWords($input.val());
211 if ( words.length > 1 ) {
212 v = words.slice(0, words.length - 1).join( options.multipleSeparator ) + options.multipleSeparator + v;
214 v += options.multipleSeparator;
219 $input.trigger("result", [selected.data, selected.value]);
223 function onChange(crap, skipPrevCheck) {
224 if( lastKeyPressCode == KEY.DEL ) {
229 var currentValue = $input.val();
231 if ( !skipPrevCheck && currentValue == previousValue )
234 previousValue = currentValue;
236 currentValue = lastWord(currentValue);
237 if ( currentValue.length >= options.minChars) {
238 $input.addClass(options.loadingClass);
239 if (!options.matchCase)
240 currentValue = currentValue.toLowerCase();
241 request(currentValue, receiveData, hideResultsNow);
248 function trimWords(value) {
252 var words = value.split( options.multipleSeparator );
254 $.each(words, function(i, value) {
256 result[i] = $.trim(value);
261 function lastWord(value) {
262 if ( !options.multiple )
264 var words = trimWords(value);
265 return words[words.length - 1];
268 // fills in the input box w/the first match (assumed to be the best match)
269 // q: the term entered
270 // sValue: the first matching result
271 function autoFill(q, sValue){
272 // autofill in the complete box w/the first match as long as the user hasn't entered in more data
273 // if the last user key pressed was backspace, don't autofill
274 if( options.autoFill && (lastWord($input.val()).toLowerCase() == q.toLowerCase()) && lastKeyPressCode != KEY.BACKSPACE ) {
275 // fill in the value (keep the case the user has typed)
276 $input.val($input.val() + sValue.substring(lastWord(previousValue).length));
277 // select the portion of the value not typed by the user (so the next character will erase)
278 $.Autocompleter.Selection(input, previousValue.length, previousValue.length + sValue.length);
282 function hideResults() {
283 clearTimeout(timeout);
284 timeout = setTimeout(hideResultsNow, 200);
287 function hideResultsNow() {
288 var wasVisible = select.visible();
290 clearTimeout(timeout);
292 if (options.mustMatch) {
293 // call search and run callback
296 // if no value found, clear the input box
298 if (options.multiple) {
299 var words = trimWords($input.val()).slice(0, -1);
300 $input.val( words.join(options.multipleSeparator) + (words.length ? options.multipleSeparator : "") );
309 // position cursor at end of input field
310 $.Autocompleter.Selection(input, input.value.length, input.value.length);
313 function receiveData(q, data) {
314 if ( data && data.length && hasFocus ) {
316 select.display(data, q);
317 autoFill(q, data[0].value);
324 function request(term, success, failure) {
325 if (!options.matchCase)
326 term = term.toLowerCase();
327 var data = cache.load(term);
328 data = null; // Avoid buggy cache and go to Solr every time
329 // recieve the cached data
330 if (data && data.length) {
332 // if an AJAX url has been supplied, try loading the data now
333 } else if( (typeof options.url == "string") && (options.url.length > 0) ){
336 timestamp: +new Date()
338 $.each(options.extraParams, function(key, param) {
339 extraParams[key] = typeof param == "function" ? param() : param;
343 // try to leverage ajaxQueue plugin to abort previous requests
345 // limit abortion to this input
346 port: "autocomplete" + input.name,
347 dataType: options.dataType,
353 success: function(data) {
354 var parsed = options.parse && options.parse(data) || parse(data);
355 cache.add(term, parsed);
356 success(term, parsed);
360 // if we have a failure, we need to empty the list -- this prevents the the [TAB] key from selecting the last successful match
366 function parse(data) {
368 var rows = data.split("\n");
369 for (var i=0; i < rows.length; i++) {
370 var row = $.trim(rows[i]);
372 row = row.split("|");
373 parsed[parsed.length] = {
376 result: options.formatResult && options.formatResult(row, row[0]) || row[0]
383 function stopLoading() {
384 $input.removeClass(options.loadingClass);
389 $.Autocompleter.defaults = {
390 inputClass: "ac_input",
391 resultsClass: "ac_results",
392 loadingClass: "ac_loading",
397 matchContains: false,
403 formatItem: function(row) { return row[0]; },
408 multipleSeparator: ", ",
409 highlight: function(value, term) {
410 return value.replace(new RegExp("(?![^&;]+;)(?!<[^<>]*)(" + term.replace(/([\^\$\(\)\[\]\{\}\*\.\+\?\|\\])/gi, "\\$1") + ")(?![^<>]*>)(?![^&;]+;)", "gi"), "<strong>$1</strong>");
416 $.Autocompleter.Cache = function(options) {
421 function matchSubset(s, sub) {
422 if (!options.matchCase)
424 var i = s.indexOf(sub);
425 if (options.matchContains == "word"){
426 i = s.toLowerCase().search("\\b" + sub.toLowerCase());
428 if (i == -1) return false;
429 return i == 0 || options.matchContains;
432 function add(q, value) {
433 if (length > options.cacheLength){
443 if( !options.data ) return false;
445 var stMatchSets = {},
448 // no url was specified, we need to adjust the cache length to make sure it fits the local data store
449 if( !options.url ) options.cacheLength = 1;
451 // track all options for minChars = 0
452 stMatchSets[""] = [];
454 // loop through the array and create a lookup structure
455 for ( var i = 0, ol = options.data.length; i < ol; i++ ) {
456 var rawValue = options.data[i];
457 // if rawValue is a string, make an array otherwise just reference the array
458 rawValue = (typeof rawValue == "string") ? [rawValue] : rawValue;
460 var value = options.formatMatch(rawValue, i+1, options.data.length);
461 if ( value === false )
464 var firstChar = value.charAt(0).toLowerCase();
465 // if no lookup array for this character exists, look it up now
466 if( !stMatchSets[firstChar] )
467 stMatchSets[firstChar] = [];
469 // if the match is a string
473 result: options.formatResult && options.formatResult(rawValue) || value
476 // push the current match into the set list
477 stMatchSets[firstChar].push(row);
479 // keep track of minChars zero items
480 if ( nullData++ < options.max ) {
481 stMatchSets[""].push(row);
485 // add the data items to the cache
486 $.each(stMatchSets, function(i, value) {
487 // increase the cache size
488 options.cacheLength++;
494 // populate any existing data
495 setTimeout(populate, 25);
507 if (!options.cacheLength || !length)
510 * if dealing w/local data and matchContains than we must make sure
511 * to loop through all the data collections looking for matches
513 if( !options.url && options.matchContains ){
516 // loop through all the data grids for matches
517 for( var k in data ){
518 // don't search through the stMatchSets[""] (minChars: 0) cache
519 // this prevents duplicates
522 $.each(c, function(i, x) {
523 // if we've got a match, add it to the array
524 if (matchSubset(x.value, q)) {
532 // if the exact item exists, use it
536 if (options.matchSubset) {
537 for (var i = q.length - 1; i >= options.minChars; i--) {
538 var c = data[q.substr(0, i)];
541 $.each(c, function(i, x) {
542 if (matchSubset(x.value, q)) {
543 csub[csub.length] = x;
555 $.Autocompleter.Select = function (options, input, select, config) {
572 element = $("<div/>")
574 .addClass(options.resultsClass)
575 .css("position", "absolute")
576 .appendTo(document.body);
578 list = $("<ul/>").appendTo(element).mouseover( function(event) {
579 if(target(event).nodeName && target(event).nodeName.toUpperCase() == 'LI') {
580 active = $("li", list).removeClass(CLASSES.ACTIVE).index(target(event));
581 $(target(event)).addClass(CLASSES.ACTIVE);
583 }).click(function(event) {
584 $(target(event)).addClass(CLASSES.ACTIVE);
586 // TODO provide option to avoid setting focus again after selection? useful for cleanup-on-focus
589 }).mousedown(function() {
590 config.mouseDownOnSelect = true;
591 }).mouseup(function() {
592 config.mouseDownOnSelect = false;
595 if( options.width > 0 )
596 element.css("width", options.width);
601 function target(event) {
602 var element = event.target;
603 while(element && element.tagName != "LI")
604 element = element.parentNode;
605 // more fun with IE, sometimes event.target is empty, just ignore it then
611 function moveSelect(step) {
612 listItems.slice(active, active + 1).removeClass(CLASSES.ACTIVE);
614 var activeItem = listItems.slice(active, active + 1).addClass(CLASSES.ACTIVE);
617 listItems.slice(0, active).each(function() {
618 offset += this.offsetHeight;
620 if((offset + activeItem[0].offsetHeight - list.scrollTop()) > list[0].clientHeight) {
621 list.scrollTop(offset + activeItem[0].offsetHeight - list.innerHeight());
622 } else if(offset < list.scrollTop()) {
623 list.scrollTop(offset);
628 function movePosition(step) {
631 active = listItems.size() - 1;
632 } else if (active >= listItems.size()) {
637 function limitNumberOfItems(available) {
638 return options.max && options.max < available
643 function fillList() {
645 var max = limitNumberOfItems(data.length);
646 for (var i=0; i < max; i++) {
649 var formatted = options.formatItem(data[i].data, i+1, max, data[i].value, term);
650 if ( formatted === false )
652 var li = $("<li/>").html( options.highlight(formatted, term) ).addClass(i%2 == 0 ? "ac_even" : "ac_odd").appendTo(list)[0];
653 $.data(li, "ac_data", data[i]);
655 listItems = list.find("li");
656 if ( options.selectFirst ) {
657 listItems.slice(0, 1).addClass(CLASSES.ACTIVE);
660 // apply bgiframe if available
666 display: function(d, q) {
679 if (active != 0 && active - 8 < 0) {
680 moveSelect( -active );
685 pageDown: function() {
686 if (active != listItems.size() - 1 && active + 8 > listItems.size()) {
687 moveSelect( listItems.size() - 1 - active );
693 element && element.hide();
694 listItems && listItems.removeClass(CLASSES.ACTIVE);
697 visible : function() {
698 return element && element.is(":visible");
700 current: function() {
701 return this.visible() && (listItems.filter("." + CLASSES.ACTIVE)[0] || options.selectFirst && listItems[0]);
704 var offset = $(input).offset();
706 width: typeof options.width == "string" || options.width > 0 ? options.width : $(input).width(),
707 top: offset.top + input.offsetHeight,
713 maxHeight: options.scrollHeight,
717 if($.browser.msie && typeof document.body.style.maxHeight === "undefined") {
719 listItems.each(function() {
720 listHeight += this.offsetHeight;
722 var scrollbarsVisible = listHeight > options.scrollHeight;
723 list.css('height', scrollbarsVisible ? options.scrollHeight : listHeight );
724 if (!scrollbarsVisible) {
725 // IE doesn't recalculate width when scrollbar disappears
726 listItems.width( list.width() - parseInt(listItems.css("padding-left")) - parseInt(listItems.css("padding-right")) );
732 selected: function() {
733 var selected = listItems && listItems.filter("." + CLASSES.ACTIVE).removeClass(CLASSES.ACTIVE);
734 return selected && selected.length && $.data(selected[0], "ac_data");
736 emptyList: function (){
737 list && list.empty();
740 element && element.remove();
745 $.Autocompleter.Selection = function(field, start, end) {
746 if( field.createTextRange ){
747 var selRange = field.createTextRange();
748 selRange.collapse(true);
749 selRange.moveStart("character", start);
750 selRange.moveEnd("character", end);
752 } else if( field.setSelectionRange ){
753 field.setSelectionRange(start, end);
755 if( field.selectionStart ){
756 field.selectionStart = start;
757 field.selectionEnd = end;