angucomplete-alt

This is a fork of Hidenari Nozaki's angucomplete-alt (https://github.com/darylrowland/angucomplete) with a bit of tweaks such as:

* callback function: when a selection is made by user, this callback is called with the selected object. Thanks to @nekcih for proposing this feature.
* Another callback function: when the input value changes.
* Short the result and show the entire text with bootstrap accordion
* loading bar. Thanks to @chieffancypants and his angular-loading-bar

To see a demo go here: http://ghiden.github.io/angucomplete-alt Note this is the old demo version. If you want to see the final example, check /example

###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
• Using the built in directives of angular (keyup) instead of jquery, to avoid many scope digests
• 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 regular two-way-data-binding
• callback function: when a selection is made by user, this callback is called with the selected object. Thanks to @nekcih for proposing this feature.
• Another callback function: when the input value changes.
• Short the result and show the entire text with bootstrap accordion
• loading bar. Thanks to @chieffancypants and his angular-loading-bar

Getting Started

Download the package, and include the angucomplete-alt-all.js file in your page.

bower install angucomplete-alt --save

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

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

Optionally you can use bootstrap accordion for the show more functionality. To enable:

• Include js libraries and css like:

<link rel="stylesheet" href="../bower_components/bootstrap/dist/css/bootstrap.css"/>
<script src="../bower_components/angular-bootstrap/ui-bootstrap-tpls.js"></script>

• Inject ui.bootstrap module to your dependencies
• Enable the option in the directive: use-bootstrap="true"

Local Usage

<angucomplete-alt id="ex1"
              place-holder="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-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"/>

Loading bar

Note that the loading bar is not automatically included, in order to give the possibility to place it anywhere. To enable:

• Create a container for it
• Reference that container like: cfpLoadingBarProvider.parentSelector = '#search-bar'; For more info, check the angular-loading-bar project: https://github.com/urecio/angular-loading-bar.git

Description of attributes

Attribute	Description	Required	Example
id	A unique ID for the field	Yes	members
placeholder	Placeholder text for the search field	No	Search members
pause	Max time waiting for the response	No	500
selected-object	Either an object in your scope or callback function. If you set an object, it will be two-way-bound data as usual. If you set a callback, it gets called when selection is made.	Yes	selectedObject or objectSelectedCallback
remote-url	The remote URL to hit to query for results in JSON. angucomplete will automatically append the search string on the end of this, so it must be a GET request	No	http://myserver.com/api/users/find?searchstr=
remote-url-data-field	The name of the field in the JSON object returned back that holds the Array of objects to be used for the autocomplete list.	No	results
title-field	The name of the field in the JSON objects returned back that should be used for displaying the title in the autocomplete list. Note, if you want to combine fields together, you can comma separate them here (e.g. for a first and last name combined)	Yes	firstName,lastName
description-field	The name of the field in the JSON objects returned back that should be used for displaying the description in the autocomplete list	No	twitterUsername
image-field	The name of the field in the JSON objects returned back that should be used for displaying an image in the autocomplete list	No	pic
minlength	The minimum length of string required before searching	No	3
input-class	The classes to use for styling the input box	No	form-control
match-class	If it is assigned, matching part of title is highlighted with given class style	No	highlight
local-data	The local data variable to use from your controller. Should be an array of objects	No	countriesList
search-fields	The fields from your local data to search on (comma separate them)	No	title,description
remote-url-request-formatter	A function that takes a query string and returns parameter(s) for GET. It should take the query string as argument and returns a key-value object.	No	Suppose if you need to send a query keyword and a timestamp to search API, you can write a function like this in the parent scope. $scope.dataFormatFn = function(str) { return {q: str, timestamp: +new Date()}; }
remote-url-response-formatter	A function on the scope that will modify raw response from remote API before it is rendered in the drop-down. Useful for adding data that may not be available from the API. The specified function must return the object in the format that angucomplete understands.	No	addImageUrlToObject
clear-selected	To clear out input field upon selecting an item, set this attribute to true.	No	true
override-suggestions	To override suggestions and set the value in input field to selectedObject	No	true
writting-callback	Callback to a custom function every time the input value changes	No	callBack
custom-proccessing	Call to a custom function on each row of the proccessing	No	customProccessing
sub-min-title	option to short the string. number of characteres of separation from the match to the left side of the string	No	400
sub-max-title	option to short the string. number of characteres of separation from the match to the right side of the string	No	400
sub-min-description	same of sub-min-title for description	No	400
sub-max-description	same of sub-max-title for description	No	400
show-more	hide the full text (when you are using any shorting from above) and show it with a bootstrap accordion	No	false
use-bootstrap	Possibility to use bootstrap for the accordion effect when show-more is enabled	No	false