angular jQuery UI autocomplete

Anatoly Mironov

January 4, 2013

Angular JS is one of the most developed MVC frameworks in the javascript world. Angular UI is a huge UI-centric extension of AngularJS (it is more or less like jQuery UI to the jQuery). It uses much jQuery UI and Twitter Bootstrap and provides many own components like modal dialogs, maps, tooltips, masked inputs and much more. And all this is easy to implement in your code just by adding a directive: [sourcecode language=“html”][/sourcecode] Much cleaner than listening on $(document).ready, traversing the DOM and appending the datepicker in your code: [sourcecode language=“html”][/sourcecode] [sourcecode language=“javascript”]$(document).ready(function() { var input = $("#myDate"); input.datepicker(); });[/sourcecode] All this code is invoked but outside your app code.

ui-autocomplete

Unfortunately Angular UI has no official autocomplete directive. There is a discussion about it on many forums. There are some working implementations. But they are not complete. I looked at how ui-date is implemented. jQuery UI Datepicker and jQuery UI Autocomplete have one in common. They are relying on a set of options. To create a directive for each option would make the html code too dirty. Here is a directive ui-autocomplete which I have written that (like ui-date) takes a options object as parameters. This options object has to be appended to the $scope variable in the angular controller: [sourcecode language=“javascript”] var uiAutocomplete = function() { return { require: ‘?ngModel’, link: function(scope, element, attrs, controller) { var getOptions = function() { return angular.extend({}, scope.$eval(attrs.uiAutocomplete)); }; var initAutocompleteWidget = function () { var opts = getOptions(); element.autocomplete(opts); if (opts._renderItem) { element.data(“autocomplete”)._renderItem = opts._renderItem; } }; // Watch for changes to the directives options scope.$watch(getOptions, initAutocompleteWidget, true); } }; }; angular.module(‘ui.directives’).directive(‘uiAutocomplete’, [uiAutocomplete]); [/sourcecode]

Example code

[sourcecode language=“html”] [/sourcecode] Here is the angular controller: [sourcecode language=“javascript”] function AutoCompleteCtrl($scope, $http) { var search = function(request, response) { var callback = function(data) { response(data); }; $http.get("/api/orders/search?q=" + $scope.term) .success(callback); }, gotoOrderDetails = function (id) { window.location = “/orders/” + id; }, _renderItem = function (ul, item) { return $("") .data(“item.autocomplete”, item) .append("" + item.title + “”) .appendTo(ul); }, select = function (event, ui) { if (ui.item) { gotoOrderDetails(ui.item.orderId); } }; $scope.autocompleteOptions = { minLength: 1, source: search, select: select, delay: 500, _renderItem: _renderItem }; }[/sourcecode] To get the options inside the directive a function called $eval is used. Here a standard set of jQuery UI Autocomplete is used and one more: _renderItem. It is not included in the default autocomplete options, but in my case I needed to define custom rendering logic for my items. Enjoy

Edit 2013-02-15:

I have sent a pull request angular ui. See the details here

Edit 2013-02-23:

I have added support for uiConfig and change scope.$watch invokation based on Pull Request Feedback. I also published a small gist which shows how a simple ui-autocomplete can be used.

Comments from Wordpress.com

Gabriel Svennerberg - May 3, 2013

I was trying out your code and didn’t get it to work at first. I got an error where you overwrite jQuery UI’s _renderItem method. The fix was easy though. Just replace the string “autocomplete” to “ui-autocomplete”. See code below. element.data("ui-autocomplete")._renderItem = opts._renderItem;

Cem Çapulkolig - Jun 4, 2013

element.data(“autocomplete”) ===> needs to be changed to element.data(“ui-autocomplete”) for this to work in new Jquery UI

Anatoly Mironov - Jun 5, 2013

Thank you Cem! I appreciate your help. I’ll update the post.

Sergio Giusti - Mar 3, 2016

I am trying to create a lookup column in one list that lookups data from another list in the same site, the lookup list has around 4000 items and the dropdown that appears is terrible, can I use your solution to solve this on the newitem.aspx form? if so, could you provide some instructions please. Hi, I’m a complete idiot when it comes to this stuff, I have a list called ‘Staff List’, it has a column called ‘Employee ID’. I have a document library called ’eFiling’, it has a Lookup column called ‘Employee ID’ which is set to lookup the employee id field from the staff list. If I add a script editor to the newitem form how do I format your code so that it will work?

Pritesh - Jun 0, 2017

Getting “TypeError: element.autocomplete is not a function” error