Monday, June 3, 2024
 Popular · Latest · Hot · Upcoming
58
rated 0 times [  62] [ 4]  / answers: 1 / hits: 100055  / 15 Years ago, fri, march 12, 2010, 12:00:00

I’m using the jQuery UI Autocomplete plug-in. Is there a way to highlight search character sequence in drop-down results?



For example, if I have “foo bar” as data and I type foo I’ll get “foo bar” in the drop-down, like this:



“Breakfast”


More From » jquery

 Answers
33

Autocomplete



Yes, you can if you monkey-patch autocomplete.



In the autocomplete widget included in v1.8rc3 of jQuery UI, the popup of suggestions is created in the _renderMenu function of the autocomplete widget. This function is defined like this:



_renderMenu: function( ul, items ) {
var self = this;
$.each( items, function( index, item ) {
self._renderItem( ul, item );
});
},


The _renderItem function is defined like this:



_renderItem: function( ul, item) {
return $( <li></li> )
.data( item.autocomplete, item )
.append( <a> + item.label + </a> )
.appendTo( ul );
},


So what you need to do is replace that _renderItem fn with your own creation that produces the desired effect. This technique, redefining an internal function in a library, I have come to learn is called monkey-patching. Here's how I did it:



  function monkeyPatchAutocomplete() {

// don't really need this, but in case I did, I could store it and chain
var oldFn = $.ui.autocomplete.prototype._renderItem;

$.ui.autocomplete.prototype._renderItem = function( ul, item) {
var re = new RegExp(^ + this.term) ;
var t = item.label.replace(re,<span style='font-weight:bold;color:Blue;'> +
this.term +
</span>);
return $( <li></li> )
.data( item.autocomplete, item )
.append( <a> + t + </a> )
.appendTo( ul );
};
}


Call that function once in $(document).ready(...) .



Now, this is a hack, because:




  • there's a regexp obj created for every item rendered in the list. That regexp obj ought to be re-used for all items.


  • there's no css class used for the formatting of the completed part. It's an inline style.

    This means if you had multiple autocompletes on the same page, they'd all get the same treatment. A css style would solve that.




...but it illustrates the main technique, and it works for your basic requirements.



alt



updated working example: http://output.jsbin.com/qixaxinuhe






To preserve the case of the match strings, as opposed to using the case of the typed characters, use this line:



var t = item.label.replace(re,<span style='font-weight:bold;color:Blue;'> + 
$& +
</span>);


In other words, starting from the original code above, you just need to replace this.term with $&.






EDIT

The above changes every autocomplete widget on the page. If you want to change only one, see this question:

How to patch *just one* instance of Autocomplete on a page?


[#97354] Tuesday, March 9, 2010, 15 Years  [reply] [flag answer]
Only authorized users can answer the question. Please sign in first, or register a free account.
tyasiaalmap

Total Points: 294
Total Questions: 107
Total Answers: 108

Location: Libya
Member since Mon, Dec 7, 2020
4 Years ago
;