@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 21 Demo | npm | Issues | Repository

Latest tested npm release: 21.0.3 for Angular 21.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 21.0.3 for Angular 21.x applications.

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

Features

| Feature | Supported | | :--- | :---: | | Angular 21 tested published release line | ✅ | | Multi-select and single-select modes | ✅ | | Search and filter | ✅ | | Group by field | ✅ | | Custom item templates (<c-item>) | ✅ | | Custom badge templates (<c-badge>) | ✅ | | Template-driven forms (ngModel) | ✅ | | Reactive forms (formControlName) | ✅ | | Lazy loading and remote-data hooks | ✅ | | Theming via bundled CSS/SCSS | ✅ | | Primary selector <angular-multiselect> | ✅ | | Legacy compatibility alias <angular2-multiselect> | ✅ | | Versioned docs builds per Angular line | ✅ |

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 21 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.

Peer ranges are intentionally bounded to the tested Angular major. The Angular 21 line stays on >=21.0.0 <22.0.0; Angular 22 will receive its own 22.x package line after it is built and validated against Angular 22. Do not treat the Angular 21 package as an open-ended >=21.0.0 dependency.

| Package family | Framework family | Peer range | Tested release window | Demo link | | :---: | :---: | :---: | :---: | :--- | | 21.x | Angular 21 only | >=21.0.0 <22.0.0 | 21.0.3 -> 21.2.14 | Angular 21 family docs | | 20.x | Angular 20 only | >=20.0.0 <21.0.0 | 20.0.1 -> 20.3.21 | Angular 20 family docs | | 19.x | Angular 19 only | >=19.0.0 <20.0.0 | 19.0.1 -> 19.2.22 | Angular 19 family docs | | 18.x | Angular 18 only | >=18.0.0 <19.0.0 | 18.0.1 -> 18.2.14 | Angular 18 family docs | | 17.x | Angular 17 only | >=17.0.0 <18.0.0 | 17.0.1 -> 17.3.12 | Angular 17 family docs | | 16.x | Angular 16 only | >=16.0.0 <17.0.0 | 16.0.1 -> 16.2.12 | Angular 16 family docs | | 15.x | Angular 15 only | >=15.0.0 <16.0.0 | 15.0.1 -> 15.2.10 | Angular 15 family docs | | 14.x | Angular 14 only | >=14.0.0 <15.0.0 | 14.0.1 -> 14.3.0 | Angular 14 family docs | | 13.x | Angular 13 only | >=13.0.0 <14.0.0 | 13.0.1 -> 13.4.0 | Angular 13 family docs | | 12.x | Angular 12 only | >=12.0.0 <13.0.0 | 12.0.1 -> 12.2.17 | Angular 12 family docs | | 11.x | Angular 11 only | >=11.0.0 <12.0.0 | 11.0.1 -> 11.2.14 | Angular 11 family docs | | 10.x | Angular 10 only | >=10.0.0 <11.0.0 | 10.0.1 -> 10.2.5 | Angular 10 family docs | | 9.x | Angular 9 only | >=9.0.0 <10.0.0 | 9.0.1 -> 9.1.13 | Angular 9 family docs | | 8.x | Angular 8 only | >=8.0.0 <9.0.0 | 8.0.1 -> 8.2.14 | Angular 8 family docs | | 7.x | Angular 7 only | >=7.0.0 <8.0.0 | 7.0.1 -> 7.2.16 | Angular 7 family docs | | 6.x | Angular 6 only | >=6.0.0 <7.0.0 | 6.0.1 -> 6.1.10 | Angular 6 family docs | | 5.x | Angular 5 only | >=5.0.0 <6.0.0 | 5.0.1 -> 5.2.11 | Angular 5 family docs | | 4.x | Angular 4 only | >=4.0.0 <5.0.0 | 4.0.2 -> 4.4.7 | Angular 4 family docs | | 2.x | Angular 2 only | >=2.0.0 <3.0.0 | compatible with 2.x; tested on 2.4.10 | Angular 2 family docs |

Installation

npm install @stackline/[email protected] --save-exact

Install 21.0.3 for Angular 21.x applications. This line keeps the tested Angular 21 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 21 Test Matrix

The published Angular 21 release was tested in a real Angular 21.2.14 application with @stackline/[email protected]. 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:

| # | Scenario | Main settings tested | | :---: | :--- | :--- | | 01 | Basic multi | { enableSearchFilter: false } | | 02 | Search + select all | Search, select all, clear all, events | | 03 | Single without checkbox | { singleSelection: true, showCheckbox: false, enableCheckAll: false } | | 04 | Multi without checkbox | { showCheckbox: false, enableCheckAll: false } | | 05 | Selection limit | { limitSelection: 2, badgeShowLimit: 2 } | | 06 | Badge overflow | { badgeShowLimit: 2, maxHeight: 220 } | | 07 | Grouped by region | { groupBy: 'region', maxHeight: 220 } | | 08 | Disabled with value | { disabled: true } | | 09 | Empty data | { noDataLabel: 'No records found' } | | 10 | Long list with scroll | { maxHeight: 120, badgeShowLimit: 3 } | | 11 | Local lazy loading | { lazyLoading: true, maxHeight: 120, badgeShowLimit: 3 } | | 12 | Item + chip template | <c-badge> and <c-item> custom templates |

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