Awesome

angucomplete-ie8

This is a fork of angucomplete-alt and the objective is to support IE8.

To see a demo go here: http://ghiden.github.io/angucomplete-ie8

IE8

To use angucomplete-ie8 on IE8, take these steps:

1. Use angular 1.2 version.
2. Include es5-shim and es5-sham
3. Include JSON3
4. No chaining on promises

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

Getting Started

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

bower install angucomplete-ie8 --save

Or

npm install angucomplete-ie8 --save

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

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

Local Usage

<angucomplete-ie8 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"/>

Remote Usage

<angucomplete-ie8 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-ie8 input fields, send this message

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

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

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

Change Input

To set an angucomplete-ie8 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-ie8: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-hander.

$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!