Awesome

angucomplete-alt

This is a fork of Daryl Rowland's angucomplete (https://github.com/darylrowland/angucomplete) with a bit of tweaks such as:

• change long attribute names to hyphenated ones
• coding style similar to angular standard
• refactored in general
• jshint
• more test coverage

To see a demo go here: https://ghiden.github.io/angucomplete-alt

###Key Features

• Show just a title, a title and a description or a title, description and image in your autocomplete list
• Deliberately minimally styled so you can customise it to your heart's content!
• Reads JSON data and allows you to specify which fields to use for display
• Simple setup - e.g. to pull data from a server, just set the url parameter

Extra Features

• Request format function: if you need to tweak data before you send to your search API, you can set your own format function. Search query goes through your function and gets sent to your API.
• Response format function: if you need to tweak response from the server before it gets processed by the directive, you can set your own format function. Raw HTTP response goes through your function. Thanks to @nekcih for proposing this feature.
• Clear on selection: when you select an item, input field is cleared.
• Blur event handling, thanks to @leejsinclair
• Override suggestions
• You can either bind an object or callback function
  • bind an object: it works as one-way-data-binding. It gets set when a selection is made.
  • callback function: when a selection is made by user, this callback is called with the selected object. When the selection is deselected, the callback is called with undefined. Thanks to @nekcih for proposing this feature.
• Required support: It is a bit different from ng-required which becomes valid when there is any character in input field. This required becomes valid when a selection is made. Class name is "autocomplete-required" and customizable. Thanks to @alindber for the initial idea.
• Custom texts for "Searching..." and "No results found", thanks to @vhuerta for this idea.
• Be able to set initial value. This becomes handy if you use this directive for updating existing model.
• Be able to set a error callback for ajax request
• Add a callback for tracking input changes. Thanks to @urecio for the initial idea.
• Auto match
• Add callbacks for tracking focus in/out.
• Enable/disable input field
• Show scrollbar. See example #1
• Clear input by sending $broadcast from parent scope. Thanks to @Leocrest for #61.
• Override template with your own. When you use this feature, test throughly as it might break other features. Thanks to @sdbondi for #74.
• Show all items.
• Custom remote API handler which allows you to fully control how to communicate with your remote API. Thanks to @jbuquet
• Custom search function for handling local data

Angular 1.2

From v2.0.0, I have dropped the support for angular 1.2. Please use angucomplete-ie8 which still supports 1.2.

Getting Started

Download the package, and include the dist/angucomplete-alt.min.js file in your page.

bower install angucomplete-alt --save

Or

npm install angucomplete-alt --save

Then add the angucomplete-alt module to your Angular App file, e.g.

var app = angular.module('app', ["angucomplete-alt"]);

Using local data

<angucomplete-alt id="ex1"
              placeholder="Search countries"
              pause="100"
              selected-object="selectedCountry"
              local-data="countries"
              search-fields="name"
              title-field="name"
              minlength="1"
              input-class="form-control form-control-small"/>

Using local data with custom search function

<angucomplete-alt id="ex2"
              placeholder="Search people"
              pause="300"
              selected-object="selectedPerson"
              local-data="people"
              local-search="localSearch"
              title-field="firstName,surname"
              description-field="twitter"
              image-field="pic"
              minlength="1"
              input-class="form-control form-control-small"
              match-class="highlight" />

Local search function takes a string and returns an array of matched items.

// Here is a naive implementation for matching first name, last name, or full name
$scope.localSearch = function(str) {
  var matches = [];
  $scope.people.forEach(function(person) {
    var fullName = person.firstName + ' ' + person.surname;
    if ((person.firstName.toLowerCase().indexOf(str.toString().toLowerCase()) >= 0) ||
        (person.surname.toLowerCase().indexOf(str.toString().toLowerCase()) >= 0) ||
        (fullName.toLowerCase().indexOf(str.toString().toLowerCase()) >= 0)) {
      matches.push(person);
    }
  });
  return matches;
};

Example

Using remote API

<angucomplete-alt id="members"
              placeholder="Search members"
              pause="400"
              selected-object="testObj"
              remote-url="http://myserver.com/api/user/find?s="
              remote-url-data-field="results"
              title-field="firstName,surname"
              description-field="email"
              image-field="profilePic"
              input-class="form-control form-control-small"/>

It expects the returned results from remote API to have a root object. In the above example, 'results' is an array of search results.

Description of attributes

Scrollbar

To show scrollbar, you need to set the following css style to angucomplete-dropdown class, and then the directive automatically picks it up.

.angucomplete-dropdown {
    ...
    overflow-y: auto;
    max-height: 200px; // your preference
    ...
}

See example #1

Clear Input

To clear all angucomplete-alt input fields, send this message

$scope.$broadcast('angucomplete-alt:clearInput');

To clear an angucomplete-alt input field, send this message with id of the directive. For example, the id of the directive is 'autocomplete-1'.

$scope.$broadcast('angucomplete-alt:clearInput', 'autocomplete-1');

Change Input

To set an angucomplete-alt input field, send this message with id of the directive and desired value. One can pass a simple string or an object as an argument, the same rules applied as for initial-value parameter. For example, the id of the directive is 'autocomplete-1'.

$scope.$broadcast('angucomplete-alt:changeInput', 'autocomplete-1', 'Hello!');

Remote API Handler

This is an example calling search API with POST. Pass this searchAPI function to the directive as remote-api-handler.

$scope.searchAPI = function(userInputString, timeoutPromise) {
  return $http.post('/yourownapi/', {q: userInputString}, {timeout: timeoutPromise});
}

When you use remote-api-handler, these attributes are ignored:

remote-url
remote-url-request-formatter
remote-url-request-with-credentials

Callback behaviour

Callbacks selected-object and input-changed are called with the following method signature:

function ($item) {

  $item.title // or description, or image - from your angucomplete attribute configuration
  $item.originalObject // the actual object which was selected
  this.$parent // the control which caused the change, contains useful things like $index for use in ng-repeat.

}

Examples

To run examples, cd into 'examples' directory and run static http server of your choice:

cd examples
python -m SimpleHTTPServer

Contributors

Here is the list of contributors. Here is how to contribute. Of course the easiest contribution is to give it a star!