ng2-combosearch
v2.0.6
Published
Component combo search to angular 2
Downloads
182
Maintainers
Readme
ComboSearchComponent
@version 2.0.2 @author: Flávio Silva @link: https://github.com/fssolutions/ng2-combosearch
Installation
Combosearch runs on angular 2 and is available as an NPM package. You can install ng2-combosearch in your project's directory as usual:
$ npm install --save ng2-combosearch
Component combo search for Angular 2.
<combo-search nameDescription="var string" [startFill]="[true|false|yes|no]" [onDemand]="[true|false|yes|no]" [modelList]="var [Array<any>]" [(cpModel)]="var [any]" (searchText)="onYourFunction($event)" (selectItem)="onYourFunction($event)">
<template let-currentItem>
<div><b>{{currentItem.Property1}}</b> - {{currentItem.Propery2}}</div>
</template>
</combo-search>
Example
Template (.html)
<combo-search nameDescription="nameModelToShow" startFill="yes" [modelList]="modelList" (searchText)="onSearchText($event)" (selectItem)="onSelectItem($event)"></combo-search>
<combo-search nameDescription="nameModelToShow" startFill="yes" [modelList]="modelList" (searchText)="onSearchText($event)" (selectItem)="onSelectItem($event)">
<template let-myVar>
<div><b>{{myVar.Id}}</b> - {{myVar.Name}}({{myVar.User}})</div>
</template>
</combo-search>
TypeScript (.ts)
Import ComboSearchComponent
import { Ng2ComboSearchModule } from 'ng2-combosearch';
Add in your module
@NgModule({
imports: [
Ng2ComboSearchModule,
]
})
Create var to bind
private nameModelToShow: string;
private modelList: any;
Create function to receive data
private searchText(value: string){};
private onSelectItem(value: any){};
Complete Code
...
import { Ng2ComboSearchModule } from 'ng2-combosearch';
...
@NgModule({
imports: [
Ng2ComboSearchModule,
]
})
...
export class YourClass{
private nameModelToShow: string = "Name";
private modelList: Array<any> = [
{ Id: 1, Name: 'My Name', User: 'my.user', ImgProfile: '11652-589-5-689.png'},
{ Id: 2, Name: 'My Name', User: 'my.user', ImgProfile: '11652-589-5-195.png'}
];
private onSearchText(value: string){
console.info("Searching for: ", value);
// Load new model, when your search on demand;
};
private onSelectItem(value: any){
console.info("Selected Item: ", value);
};
}
Contributing
Contributions are welcome and appreciated. You can find ng2-combosearch on GitHub, feel free to start an issue or create a pull requests: https://github.com/fssolutions/ng2-combosearch
License
Copyright (c) 2016 Flávio Silva fssolutions. Licensed under the MIT License (MIT)