angular-typeahead

WebJar for angular-typeahead

License

License

MIT
Categories

Categories

Angular User Interface Web Frameworks
GroupId

GroupId

org.webjars.bower
ArtifactId

ArtifactId

angular-typeahead
Last Version

Last Version

0.2.2
Release Date

Release Date

Type

Type

jar
Description

Description

angular-typeahead
WebJar for angular-typeahead
Project URL

Project URL

http://webjars.org
Source Code Management

Source Code Management

https://github.com/Siyfion/angular-typeahead

Download angular-typeahead

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.bower/angular-typeahead/ -->
<dependency>
    <groupId>org.webjars.bower</groupId>
    <artifactId>angular-typeahead</artifactId>
    <version>0.2.2</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.bower/angular-typeahead/
implementation 'org.webjars.bower:angular-typeahead:0.2.2'
// https://jarcasting.com/artifacts/org.webjars.bower/angular-typeahead/
implementation ("org.webjars.bower:angular-typeahead:0.2.2")
'org.webjars.bower:angular-typeahead:jar:0.2.2'
<dependency org="org.webjars.bower" name="angular-typeahead" rev="0.2.2">
  <artifact name="angular-typeahead" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.bower', module='angular-typeahead', version='0.2.2')
)
libraryDependencies += "org.webjars.bower" % "angular-typeahead" % "0.2.2"
[org.webjars.bower/angular-typeahead "0.2.2"]

Dependencies

compile (1)

Group / Artifact Type Version
org.webjars.bower : typeahead.js jar [0.10.1,0.11)

Project Modules

There are no modules declared in this project.

sfTypeahead: A Twitter Typeahead directive

Build Status Coverage: 100% Version dependencies Status

A simple Angular.js directive wrapper around the Twitter Typeahead library.

Getting Started

Get angular-typeahead from your favorite source:

Note: angular-typeahead supports Angular.js v1.2.x through v1.5.x and depends on typeahead.js v0.11.x. Make sure dependencies are met in your setup:

  • global: include jQuery, angularjs and typeahead.js before angular-typeahead.js.
  • commonJS (node, browserify): angular-typeahead explicitly requires angular and typeahead.js. (note: with browserify, include jquery.js and typeahead.js externally, because angular does not define a dependency on jquery)
  • amd (require.js): angular-typeahead explicitly requires angular and declares itself as angular-typeahead. Note that typeahead.js does not work well with AMD.js, you may find this workaround useful.

Demo

Please feel free to play with the Plnkr: LIVE DEMO

Usage

<input type="text" datasets="datasets" options="options" ng-model="model" editable="editable" sf-typeahead />

See the Plnkr LIVE DEMO for a complete integrated example.

Parameters

Parameter Default Description
datasets {} One or an array of twitter typeahead datasets.
options {} Options parameter passed directly to twitter typeahead.
allow-custom true Boolean. If false, the model value can not take custom values as text is typed in the input field.

Contributing

Please feel free to add any issues to the GitHub issue tracker.

Contributions are welcome but please try to adhere to the folowing guidelines:

Testing

Any code you write should be tested. Test the "happy path" as well as corner cases. Code cannot be merged in master unless it achieves 100% coverage on everything. To run tests automatically when a file changes, run npm run watch.

Tests run in Chrome by default, but you can override this by setting the KARMA_BROWSER environment variable. Example:

KARMA_BROWSER=Firefox npm run watch
KARMA_BROWSER=PhantomJS npm run watch

If you are not sure how to test something, ask about it in your pull request description.

JSHint

I recommend you use a jshint plugin in your editor, this will help you spot errors faster and make it easier to write clean code that is going to pass QA. In any case, npm run watch runs jshint on the code whenever you save.

Versions

Version
0.2.2