@stackline/angular-multiselect-dropdown

A maintained Angular multiselect dropdown for classic Angular forms workflows, with search, grouping, custom item and badge templates, lazy loading, custom CSS/SCSS theming, and support for both template-driven and reactive forms.

Documentation & Live Demos | Angular 4 Demo | npm | Issues | Repository

Latest tested npm release: 4.0.2 for Angular 4.x

Credits: Original upstream copyright is preserved in the license. Current maintenance, Angular line stewardship, publishing, and documentation by Alexandro Paixao Marques.

Why this library?

The original angular2-multiselect-dropdown package became difficult to keep current across multiple Angular generations. This maintained package keeps the classic API and template structure intact, introduces the new primary selector <angular-multiselect>, preserves the legacy alias <angular2-multiselect>, and publishes the project line by line so older applications can keep a predictable upgrade path.

The repository contains the full documentation matrix from Angular 2 through Angular 21. The current public npm release is 4.0.2 for Angular 4.x applications.

The Angular 4 package is compatible with Angular 4.x and was tested in a real Angular 4.4.7 application before npm publication.

Features

Table of Contents

1. Rename Note
2. Angular Version Compatibility
3. Installation
4. Setup
5. Custom CSS and SCSS Themes
6. Basic Usage
7. Official Angular 4 Test Matrix
8. Custom Templates
9. Forms Integration
10. Lazy Loading and Remote Data
11. Events
12. Run Locally
13. License

Rename Note

• new package: @stackline/angular-multiselect-dropdown
• previous package: @stackline/angular2-multiselect-dropdown
• primary selector: <angular-multiselect>
• legacy alias still accepted only for compatibility: <angular2-multiselect>

Angular Version Compatibility

Each package family only installs on its matching Angular family. Framework major and package major are not always the same package number, so use the package family column below.

Installation

npm install @stackline/angular-multiselect-dropdown@4.0.2 --save-exact

Install 4.0.2 for Angular 4.x applications. This line keeps the tested Angular 4 behavior, makes <angular-multiselect> the documented standard selector, and keeps <angular2-multiselect> only as a legacy compatibility alias.

Setup

1. Import the module

import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { FormsModule } from '@angular/forms';
import { AngularMultiSelectModule } from '@stackline/angular-multiselect-dropdown';

@NgModule({
  imports: [
    BrowserModule,
    FormsModule,
    AngularMultiSelectModule
  ]
})
export class AppModule {}

2. Add the default theme

"styles": [
  "node_modules/@stackline/angular-multiselect-dropdown/themes/default.theme.css"
]

Custom CSS and SCSS Themes

The package also ships a full custom starter theme in both formats:

• node_modules/@stackline/angular-multiselect-dropdown/themes/custom.theme.scss
• node_modules/@stackline/angular-multiselect-dropdown/themes/custom.theme.css

Use the scss file when you want to take over the component styles completely and keep the theme in your app source:

"styles": [
  "src/styles.scss",
  "src/styles/multiselect-dropdown.theme.scss"
]

Start src/styles/multiselect-dropdown.theme.scss from the package file above and edit the selectors and tokens freely.

Use the css file when you want a plain compiled starter that can be copied and adjusted without a Sass pipeline.

Basic Usage

dropdownList = [
  { id: 1, itemName: 'Brazil' },
  { id: 2, itemName: 'Canada' },
  { id: 3, itemName: 'Portugal' },
  { id: 4, itemName: 'United States' },
  { id: 5, itemName: 'Argentina' },
  { id: 6, itemName: 'Germany' },
  { id: 7, itemName: 'Japan' },
  { id: 8, itemName: 'South Africa' }
];

selectedItems = [{ id: 2, itemName: 'Canada' }];

dropdownSettings = {
  singleSelection: false,
  text: 'Classic basic',
  selectAllText: 'Select all',
  unSelectAllText: 'Clear all',
  enableSearchFilter: true,
  searchPlaceholderText: 'Search',
  badgeShowLimit: 4,
  maxHeight: 260,
  showCheckbox: true,
  noDataLabel: 'No data',
  theme: 'classic',
  tagToBody: false
};

<angular-multiselect
  [data]="dropdownList"
  [(ngModel)]="selectedItems"
  [settings]="dropdownSettings"
  (onSelect)="onItemSelect($event)"
  (onDeSelect)="onItemDeSelect($event)"
  (onSelectAll)="onSelectAll($event)"
  (onDeSelectAll)="onDeSelectAll($event)">
</angular-multiselect>

Official Angular 4 Test Matrix

The published Angular 4 release was tested in a real Angular 4.4.7 application with @stackline/angular-multiselect-dropdown@4.0.2. The docs now use the same examples from that test app.

Switch between skins through the settings object:

settings = {
  text: 'Classic basic',
  theme: 'classic'
};

materialSettings = {
  text: 'Material basic',
  theme: 'material'
};

The same twelve scenarios are validated for both classic and material:

Custom Templates

<angular-multiselect
  [data]="dropdownList"
  [(ngModel)]="selectedItems"
  [settings]="dropdownSettings">
  <c-item>
    <ng-template let-item="item">
      <label>{{ item.itemName }}</label>
      <img [src]="item.image" style="width: 24px; margin-left: 8px;" />
    </ng-template>
  </c-item>
</angular-multiselect>

<angular2-multiselect> remains available only as a legacy compatibility alias for applications migrating from the old outdated plugin. New code and all current examples should use <angular-multiselect>.

Forms Integration

Template-driven forms

<form #form="ngForm">
  <angular-multiselect
    [data]="skills"
    [(ngModel)]="selectedSkills"
    [settings]="settings"
    name="skills"
    required>
  </angular-multiselect>
</form>

Reactive forms

<form [formGroup]="userForm">
  <angular-multiselect
    [data]="skills"
    [settings]="settings"
    formControlName="skills">
  </angular-multiselect>
</form>

Lazy Loading and Remote Data

Enable lazy loading through the settings object and respond to the scroll event from your container logic:

settings = {
  text: 'Select Items',
  enableSearchFilter: true,
  lazyLoading: true,
  labelKey: 'name',
  primaryKey: 'id'
};

The versioned docs include working examples for lazy loading, remote data, grouping, templating, and forms usage.

For sticky cards, constrained containers, or dashboard layouts, keep tagToBody: false so the dropdown panel stays anchored to the field and does not jump across the page.

Events

The classic output contract is preserved:

• (onSelect)
• (onDeSelect)
• (onSelectAll)
• (onDeSelectAll)
• (onAddFilterNewItem)

Run Locally

npm install
npm run docs:sync

License

MIT