@shadowmanu/ng2-auto-complete
v0.7.10-beta.2
Published
Angular2 Input Autocomplete
Downloads
4
Maintainers
Readme
ng2-auto-complete
Angular2 Auto Complete
Plunker Example: http://plnkr.co/edit/3pB1Gx?p=preview
Install
install ng2-auto-complete
$ npm install ng2-auto-complete --save
add
map
andpackages
to yoursystemjs.config.js
map['ng2-auto-complete'] = 'node_modules/ng2-auto-complete/dist'; packages['ng2-auto-complete'] = { main: 'ng2-auto-complete.umd.js', defaultExtension: 'js' }
import Ng2AutoCompleteModule to your AppModule
import { Ng2AutoCompleteModule } from 'ng2-auto-complete'; @NgModule({ imports: [BrowserModule, FormsModule, Ng2AutoCompleteModule], declarations: [AppComponent], providers: [HTTP_PROVIDERS], bootstrap: [ AppComponent ] }) export class AppModule { }
Usage it in your code
<input auto-complete [(ngModel)]="myData" [source]="mySource" />
For full example, please check test
directory to see the example of;
systemjs.config.js
app.module.ts
- and
app.component.ts
.
Contributors are welcomed
This module is only improved and maintained by contributors like you;
As a contributor, it's NOT required to be skilled in Javascript nor Angular2. You can contribute to the following;
- Updating README.md
- Making more and clearer comments
- Answering issues and building FAQ
- Documentation
- Translation
In result of your active contribution, you will be listed as a core contributor on https://ng2-ui.github.io, and a member of ng2-ui too.
If you are interested in becoming a contributor and/or a member of ng-ui,
please send me email to allenhwkim AT gmail.com
with your github id.
attributes
All options are optional except ngModel and source
ngModel
, any, variable that autocomplete result is assigned tosource
, array or string, required. data source for dropdown listauto-complete-placeholder
, string, autocomplete input guide textlist-formatter
, function variable name, custom list formatting function.e.g. 'myListFormatter', not 'myListFormatter()'path-to-data
, string, e.g.,data.myList
, path to array data in http responsemin-chars, number
, when source is remote data, the number of character to see dropdown listvalue-property-name
, string, key name of value. default isid
display-property-name
, string, key name of text to show. default isvalue
blank-option-text
, string, guide text to allow empty value to be selected as in empty value ofoption
tag.valueChanged
/ngModelChange
, callback function that is executed when a new dropdown is selected. e.g.(valueChanged)="myCallback($event)"
loading-text
, text to be displayed when loading. Default, "Loading"
For Developers
To start
$ git clone https://github.com/ng2-ui/ng2-auto-complete.git
$ cd ng2-auto-complete
$ npm install
$ npm run build # to build `dist` directory
$ npm start
$ go to /app