angular4-multiselect-dropdown

Angular 2 and Angular 4 multiselect dropdown component.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
angular4-multiselect-dropdown
462.0.05 years ago5 years agoMinified + gzip package size for angular4-multiselect-dropdown in KB

Popular Searches

Readme

Angular4 Multiselect Dropdown
npm version downloads license Angular 4 multiselect dropdown component for web applications. Easy to integrate and use. (This is modified version of https://github.com/CuppaLabs/angular2-multiselect-dropdown)

Table of Contents

  1. Getting Started
  1. Installation
  1. Usage
  1. Templates
  1. Template Driven Forms support
  1. Reactive Forms support
  1. Settings configuration
  1. Callbacks and events
  1. Lazy lodaing - handle large data lists
  1. Group By feature
  1. Search filter for both plain list and grouped list
  1. Custom Search / Search API

Getting Started

Installation

  • The Mutiselect Dropdown package is published on the npm Registry.
  • Install the package :
`npm install angular4-multiselect-dropdown`
  • Once installed import AngularMultiSelectModule from the installed package into your module as follows:

Usage

Import AngularMultiSelectModule into NgModule in app.module.ts ```js import { AngularMultiSelectModule } from 'angular4-multiselect-dropdown/angular4-multiselect-dropdown'; @NgModule({ // ... imports: 
AngularMultiSelectModule,
 // ... }) ``` Declare the component data variables and options in your component where you want to consume the dropdown component. ```js import { Component, OnInit } from '@angular/core'; export class AppComponent implements OnInit { 
dropdownList = [];
selectedItems = [];
dropdownSettings = {};
ngOnInit(){
this.dropdownList = [
{"id":1,"itemName":"India"},
{"id":2,"itemName":"Singapore"},
{"id":3,"itemName":"Australia"},
{"id":4,"itemName":"Canada"},
{"id":5,"itemName":"South Korea"},
{"id":6,"itemName":"Germany"},
{"id":7,"itemName":"France"},
{"id":8,"itemName":"Russia"},
{"id":9,"itemName":"Italy"},
{"id":10,"itemName":"Sweden"}
];
this.selectedItems = [
{"id":2,"itemName":"Singapore"},
{"id":3,"itemName":"Australia"},
{"id":4,"itemName":"Canada"},
{"id":5,"itemName":"South Korea"}
];
this.dropdownSettings = { 
singleSelection: false, 
text:"Select Countries",
selectAllText:'Select All',
unSelectAllText:'UnSelect All',
enableSearchFilter: true,
classes:"myclass custom-class"
};            
}
onItemSelect(item:any){
console.log(item);
console.log(this.selectedItems);
}
OnItemDeSelect(item:any){
console.log(item);
console.log(this.selectedItems);
}
onSelectAll(items: any){
console.log(items);
}
onDeSelectAll(items: any){
console.log(items);
}
} ``` Add the following component tag in you template ```html data="dropdownList" (ngModel)="selectedItems" 
[settings]="dropdownSettings" 
(onSelect)="onItemSelect($event)" 
(onDeSelect)="OnItemDeSelect($event)"
(onSelectAll)="onSelectAll($event)"
(onDeSelectAll)="onDeSelectAll($event)"></angular4-multiselect>
```

Template - For custom html of menu item

```html data="dropdownList" (ngModel)="selectedItems" settings="dropdownSettings"> 
<ng-template let-item="item">
<label style="color: #333;min-width: 150px;">{{item.itemName}}</label>
<img [src]="item.image" style="width: 30px; border: 1px solid #efefef;margin-right: 20px;" />
<label>Capital - {{item.capital}}</label>
</ng-template>
```

Template - For custom html of Selected item - badge

```html data="dropdownList" (ngModel)="selectedItems" settings="dropdownSettings"> 
<ng-template let-item="item">
<label style="margin: 0px;">{{item.itemName}}</label>
<img [src]="item.image" style="width: 16px; margin-right: 5px;" />
</ng-template>
```

Template Driven Forms support

```html 
<div class="form-group">
<label for="name">Skills</label>
<angular4-multiselect [data]="itemList" [(ngModel)]="formModel.skills" 
[settings]="settings" 
(onSelect)="onItemSelect($event)"
(onDeSelect)="OnItemDeSelect($event)" 
(onSelectAll)="onSelectAll($event)" 
(onDeSelectAll)="onDeSelectAll($event)" name="skills">
</angular4-multiselect>
</div>
``` ```js formModel = { 
name: '',
email: 'ascasc@aa.com',
skills: [{ "id": 1, "itemName": "Angular" }]
};
```

Reactive Forms support

```html formGroup="userForm" novalidate style="border: 1px solid #ccc; padding: 10px;"> 
<div class="form-group">
<label for="name">Skills</label>
<angular4-multiselect [data]="itemList" [(ngModel)]="selectedItems" 
[settings]="settings" 
(onSelect)="onItemSelect($event)"
(onDeSelect)="OnItemDeSelect($event)" 
(onSelectAll)="onSelectAll($event)" 
(onDeSelectAll)="onDeSelectAll($event)" formControlName="skills">
</angular4-multiselect>
</div>
``` ```js userForm: FormGroup; this.userForm = this.fb.group({ 
name: '',
email: ['', Validators.required],
skills: [[], Validators.required]
});
```

Settings

The following list of settings are supported by the component. Configure the settings to meet your requirement. | Setting |Type | Description | Default Value | |:--- |:--- |:--- |:--- | | singleSelection | Boolean | To set the dropdown for single item selection only. | false | | text | String | Text to be show in the dropdown, when no items are selected. | 'Select' | | enableCheckAll | Boolean | Enable the option to select all items in list | false | | selectAllText | String | Text to display as the label of select all option | Select All | | unSelectAllText | String | Text to display as the label of unSelect option | UnSelect All | | enableSearchFilter | Boolean | Enable filter option for the list. | false | | maxHeight | Number | Set maximum height of the dropdown list in px. | 300 | | badgeShowLimit | Number | Limit the number of badges/items to show in the input field. If not set will show all selected. | All | | classes | String | Custom classes to the dropdown component. Classes are added to the dropdown selector tag. To add multiple classes, the value should be space separated class names.| '' | | limitSelection | Number | Limit the selection of number of items from the dropdown list. Once the limit is reached, all unselected items gets disabled. | none | | disabled | Boolean | Disable the dropdown | false | | searchPlaceholderText | String | Custom text for the search placeholder text. Default value would be 'Search' | 'Search' | | groupBy | String | Name of the field by which the list should be grouped. | none | | searchAutofocus | Boolean | Autofocus search input field| true | | labelKey | String | The property name(Object propery nested -e.g item.data.value) which should be rendered as label in the dropdown | itemName | | primaryKey | String | The property by which the object is identified. Default is 'id'.| id | | position | String | Set the position of the dropdown list to 'top' or 'bottom'| bottom | | noDataLabel | String | Label text when no data is available in the list| 'No Data Available' | | searchBy | Array | Search the list by certain properties of the list item. Ex: "itemName, "id","name". Deafult is , it will search the list by all the properties of list item | |

Callback Methods

  • onSelect - Return the selected item on selection.
Example : (onSelect)="onItemSelect($event)"
  • onDeSelect - Return the un-selected item on un-selecting.
Example : (onDeSelect)="OnItemDeSelect($event)"
  • onSelectAll - Return the list of all selected items.
Example : (onSelectAll)="onSelectAll($event)"
  • onDeSelectAll - Returns an empty array.
Example : (onDeSelectAll)="onDeSelectAll($event)"
  • onOpen - Callback method fired after the dropdown opens
Example : (onOpen)="onOpen($event)"
  • onClose - Callback method, fired when the dropdown is closed
Example : (onClose)="onClose($event)"

Run locally

  • Clone the repository or downlod the .zip,.tar files.
  • Run npm install
  • Run ng serve for a dev server
  • Navigate to http://localhost:4200/
The app will automatically reload if you change any of the source files.

License

MIT License.