Skip to content

YasuhiroYoshida/angucomplete

 
 

Repository files navigation

angucomplete

A simple but powerful AngularJS directive that allows you to quickly create autocomplete boxes that pull data either from a server or local variable.

To see a demo go here: http://darylrowland.github.io/angucomplete

###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

Getting Started

Download the code, and include the angucomplete.js file in your page. Then add the angucomplete module to your Angular App file, e.g.

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

Local Usage

<angucomplete id="ex1"
              placeholder="Search countries"
              pause="100"
              selectedobject="selectedCountry"
              localdata="countries"
              searchfields="name"
              titlefield="name"
              minlength="1"
              inputclass="form-control form-control-small"/>

Remote Usage

<angucomplete id="members"
              placeholder="Search members"
              pause="400"
              selectedobject="testObj"
              url="http://myserver.com/api/user/find?s="
              datafield="results"
              titlefield="firstName,surname"
              descriptionfield="email"
              imagefield="profilePic"
              inputclass="form-control form-control-small"/>

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 The time to wait (in milliseconds) before searching when the user enters new characters No 400
selectedObject Where to store the selected object in your model/controller (like ng-model) Yes myObject
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=
datafield 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
titlefield 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
descriptionfield 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
imagefield 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
inputclass The classes to use for styling the input box No form-control
localdata The local data variable to use from your controller. Should be an array of objects No countriesList
searchfields The fields from your local data to search on (comma separate them) No title,description

About

AngularJS Autocomplete Directive

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 63.2%
  • CSS 36.8%