Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 1,000,000+ packages pre-installed, including @ng-select/ng-select with all npm packages installed. Try it out:

require("@angular/common/package.json"); // @angular/common is a peer dependency. require("@angular/core/package.json"); // @angular/core is a peer dependency. require("@angular/forms/package.json"); // @angular/forms is a peer dependency. var ngSelect = require("@ng-select/ng-select")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

@ng-select/ng-select v5.0.8

Angular ng-select - All in One UI Select, Multiselect and Autocomplete

npm version Coverage Status gzip bundle size

Angular ng-select - Lightweight all in one UI Select, Multiselect and Autocomplete

See Demo page.


Versions

Angularng-select
>=9.0.0 <10.0.0v4.x
>=8.0.0 <9.0.0v3.x
>=6.0.0 <8.0.0v2.x
v5.x.xv1.x

Table of contents

Features

  • [x] Custom binding to property or object
  • [x] Custom option, label, header and footer templates
  • [x] Virtual Scroll support with large data sets (>5000 items).
  • [x] Infinite scroll
  • [x] Keyboard navigation
  • [x] Multiselect
  • [x] Flexible autocomplete with client/server filtering
  • [x] Custom search
  • [x] Custom tags
  • [x] Append to
  • [x] Group items
  • [x] Output events
  • [x] Accessibility
  • [x] Good base functionality test coverage
  • [x] Themes

Warning

Library is under active development and may have API breaking changes for subsequent major versions after 1.0.0.

Getting started

Step 1: Install ng-select:

NPM

npm install --save @ng-select/ng-select

YARN

yarn add @ng-select/ng-select

Step 2: Import the NgSelectModule and angular FormsModule module:

import { NgSelectModule } from '@ng-select/ng-select';
import { FormsModule } from '@angular/forms';

@NgModule({
  declarations: [AppComponent],
  imports: [NgSelectModule, FormsModule],
  bootstrap: [AppComponent]
})
export class AppModule {}

Step 3: Include a theme:

To allow customization and theming, ng-select bundle includes only generic styles that are necessary for correct layout and positioning. To get full look of the control, include one of the themes in your application. If you're using the Angular CLI, you can add this to your styles.scss or include it in .angular-cli.json (Angular v5 and below) or angular.json (Angular v6 onwards).

@import "~@ng-select/ng-select/themes/default.theme.css";
// ... or 
@import "~@ng-select/ng-select/themes/material.theme.css";

Step 4 (Optional): Configuration

You can also set global configuration and localization messages by injecting NgSelectConfig service, typically in your root component, and customize the values of its properties in order to provide default values.

  constructor(private config: NgSelectConfig) {
      this.config.notFoundText = 'Custom not found';
      this.config.appendTo = 'body';
      // set the bindValue to global config when you use the same 
      // bindValue in most of the place. 
      // You can also override bindValue for the specified template 
      // by defining `bindValue` as property
      // Eg : <ng-select bindValue="some-new-value"></ng-select>
      this.config.bindValue = 'value';
  }

Usage

Define options in your consuming component:

@Component({...})
export class ExampleComponent {

    selectedCar: number;

    cars = [
        { id: 1, name: 'Volvo' },
        { id: 2, name: 'Saab' },
        { id: 3, name: 'Opel' },
        { id: 4, name: 'Audi' },
    ];
}

In template use ng-select component with your options

<!--Using ng-option and for loop-->
<ng-select [(ngModel)]="selectedCar">
   <ng-option *ngFor="let car of cars" [value]="car.id">{{car.name}}</ng-option>
</ng-select>

<!--Using items input-->
<ng-select [items]="cars" 
           bindLabel="name" 
           bindValue="id" 
           [(ngModel)]="selectedCar">
</ng-select>

For more detailed examples see Demo page

SystemJS

If you are using SystemJS, you should also adjust your configuration to point to the UMD bundle.

In your systemjs config file, map needs to tell the System loader where to look for ng-select:

map: {
  '@ng-select/ng-select': 'node_modules/@ng-select/ng-select/bundles/ng-select.umd.js',
}

API

Inputs

InputTypeDefaultRequiredDescription
[addTag]boolean \| ((term: string) => any \| Promise<any>)falsenoAllows to create custom options.
addTagTextstringAdd itemnoSet custom text when using tagging
appearancestringunderlinenoAllows to select dropdown appearance. Set to outline to add border instead of underline (applies only to Material theme)
appendTostringnullnoAppend dropdown to body or any other element using css selector. For correct positioning body should have position:relative
bindValuestring-noObject property to use for selected model. By default binds to whole object.
bindLabelstringlabelnoObject property to use for label. Default label
[closeOnSelect]booleantruenoWhether to close the menu when a value is selected
clearAllTextstringClear allnoSet custom text for clear all icon title
[clearable]booleantruenoAllow to clear selected value. Default true
[clearOnBackspace]booleantruenoClear selected values one by one when clicking backspace. Default true
[compareWith](a: any, b: any) => boolean(a, b) => a === bnoA function to compare the option values with the selected values. The first argument is a value from an option. The second is a value from the selection(model). A boolean should be returned.
dropdownPositionbottom | top | autoautonoSet the dropdown position on open
[groupBy]string | FunctionnullnoAllow to group items by key or function expression
[groupValue](groupKey: string, cildren: any[]) => Object-noFunction expression to provide group value
[selectableGroup]booleanfalsenoAllow to select group when groupBy is used
[selectableGroupAsModel]booleantruenoIndicates whether to select all children or group itself
[items]Array<any>[]yesItems array
[loading]boolean-noYou can set the loading state from the outside (e.g. async items loading)
loadingTextstringLoading...noSet custom text when for loading items
labelForIdstring-noId to associate control with label.
[markFirst]booleantruenoMarks first item as focused when opening/filtering.
[isOpen]boolean-noAllows manual control of dropdown opening and closing. True - won't close. False - won't open.
maxSelectedItemsnumbernonenoWhen multiple = true, allows to set a limit number of selection.
[hideSelected]booleanfalsenoAllows to hide selected items.
[multiple]booleanfalsenoAllows to select multiple items.
notFoundTextstringNo items foundnoSet custom text when filter returns empty result
placeholderstring-noPlaceholder text.
[searchable]booleantruenoAllow to search for value. Default true
[readonly]booleanfalsenoSet ng-select as readonly. Mostly used with reactive forms.
[searchFn](term: string, item: any) => booleannullnoAllow to filter by custom search function
[searchWhileComposing]booleantruenoWhether items should be filtered while composition started
[trackByFn](item: any) => anynullnoProvide custom trackBy function
[clearSearchOnAdd]booleantruenoClears search input when item is selected. Default true. Default false when closeOnSelect is false
[editableSearchTerm]booleanfalsenoAllow to edit search query if option selected. Default false. Works only if multiple is false.
[selectOnTab]booleanfalsenoSelect marked dropdown item using tab. Default false
[openOnEnter]booleantruenoOpen dropdown using enter. Default true
[typeahead]Subject-noCustom autocomplete or advanced filter.
[minTermLength]number0noMinimum term length to start a search. Should be used with typeahead
typeToSearchTextstringType to searchnoSet custom text when using Typeahead
[virtualScroll]booleanfalsenoEnable virtual scroll for better performance when rendering a lot of data
[inputAttrs]{ [key: string]: string }-noPass custom attributes to underlying input element
[tabIndex]number-noSet tabindex on ng-select
[keyDownFn]($event: KeyboardEvent) => booltruenoProvide custom keyDown function. Executed before default handler. Return false to suppress execution of default key down handlers

Outputs

OutputDescription
(add)Fired when item is added while [multiple]="true". Outputs added item
(blur)Fired on select blur
(change)Fired on model change. Outputs whole model
(close)Fired on select dropdown close
(clear)Fired on clear icon click
(focus)Fired on select focus
(search)Fired while typing search term. Outputs search term with filtered items
(open)Fired on select dropdown open
(remove)Fired when item is removed while [multiple]="true"
(scroll)Fired when scrolled. Provides the start and end index of the currently available items. Can be used for loading more items in chunks before the user has scrolled all the way to the bottom of the list.
(scrollToEnd)Fired when scrolled to the end of items. Can be used for loading more items in chunks.

Methods

NameDescription
openOpens the select dropdown panel
closeCloses the select dropdown panel
focusFocuses the select element
blurBlurs the select element

Other

NameTypeDescription
[ngOptionHighlight]directiveHighlights search term in option. Accepts search term. Should be used on option element. README
NgSelectConfigconfigurationConfiguration provider for the NgSelect component. You can inject this service and provide application wide configuration.
SELECTION_MODEL_FACTORYserviceDI token for SelectionModel implementation. You can provide custom implementation changing selection behaviour.

Custom selection logic

Ng-select allows to provide custom selection implementation using SELECTION_MODEL_FACTORY. To override default logic provide your factory method in your angular module.

// app.module.ts
providers: [
    { provide: SELECTION_MODEL_FACTORY, useValue: <SelectionModelFactory>CustomSelectionFactory }
]

// selection-model.ts
export function CustomSelectionFactory() {
    return new CustomSelectionModel();
}

export class CustomSelectionModel implements SelectionModel {
    ...
}

Change Detection

Ng-select component implements OnPush change detection which means the dirty checking checks for immutable data types. That means if you do object mutations like:

this.items.push({id: 1, name: 'New item'})

Component will not detect a change. Instead you need to do:

this.items = [...this.items, {id: 1, name: 'New item'}];

This will cause the component to detect the change and update. Some might have concerns that this is a pricey operation, however, it is much more performant than running ngDoCheck and constantly diffing the array.

Custom styles

If you are not happy with default styles you can easily override them with increased selector specificity or creating your own theme. This applies if you are using no ViewEncapsulation or adding styles to global stylesheet. E.g.

<ng-select class="custom"></ng-select>
.ng-select.custom {
    border:0px;
    min-height: 0px;
    border-radius: 0;
}
.ng-select.custom .ng-select-container  {            
    min-height: 0px;
    border-radius: 0;
}

If you are using ViewEncapsulation, you could use special ::ng-deep selector which will prevent scoping for nested selectors altough this is more of a workaround and we recommend using solution described above.

.ng-select.custom ::ng-deep .ng-select-container  {            
    min-height: 0px;
    border-radius: 0;
}

WARNING: Keep in mind that ng-deep is deprecated and there is no alternative to it yet. See Here.

Validation state

By default when you use reactive forms validators or template driven forms validators css class ng-invalid will be applied on ng-select. You can show errors state by adding custom css style

ng-select.ng-invalid.ng-touched .ng-select-container {
    border-color: #dc3545;
    box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 0 3px #fde6e8;
}

Contributing

Contributions are welcome. You can start by looking at issues with label Help wanted or creating new Issue with proposal or bug report. Note that we are using https://conventionalcommits.org/ commits format.

Development

Perform the clone-to-launch steps with these terminal commands.

Run demo page in watch mode

git clone https://github.com/ng-select/ng-select
cd ng-select
yarn
yarn run start

Testing

yarn run test
or
yarn run test:watch

Release

To release to npm just run ./release.sh, of course if you have permissions ;)

Inspiration

This component is inspired by React select and Virtual scroll. Check theirs amazing work and components :)

Metadata

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free