ng2-tag-input

Angular2 Tag Input

This is a component for Angular 2. Design and API are blandly inspired by Angular Material's md-chips.

Demo

Check out the live demo (with source code) here http://www.webpackbin.com/VkRLliDHW.

Quick start. Install the component from NPM by running:

npm install ng2-tag-input --save

If you want to run the tests, run the command:

npm test

Angular 2 Configuration (RC.3)

The component is updated to use the latest version of Angular 2 forms. This means it requires some configuration to correctly work with your app. Ensure, you are registering the following providers when bootstrapping the app:

import {provide, PLATFORM_DIRECTIVES} from '@angular/core';
import { disableDeprecatedForms, provideForms, REACTIVE_FORM_DIRECTIVES } from '@angular/forms';
import {App} from './home/home';

bootstrap(App, [
    disableDeprecatedForms(),
    provideForms(),
    {
          provide: PLATFORM_DIRECTIVES,
          useValue: [REACTIVE_FORM_DIRECTIVES],
          multi: true
    }
])

Please do have a look at the file demo/app.ts if you are unsure how to configure the app.

Usage

Once installed, import the TagInput component and use it in your container component:

import { TagInput } from 'ng2-tag-input';
import { Component } from '@angular2/core';

@Component({
    selector: 'app',
    directives: [TagInput],
    template: `<tag-input [(ngModel)]='items'></tag-input>`
});
export class App {
    items = ['Pizza', 'Pasta', 'Parmesan'];
    // ...
}

API

@Input

• placeholder - [?string] - String that sets the placeholder of the input for entering new terms.
• secondaryPlaceholder - [?string] - String that sets the placeholder of the input for entering new terms when there are 0 items entered.
• maxItems - [?number] - Sets the maximum number of items it is possible to enter.
• readonly - [?boolean] - Sets the tag input static, not allowing deletion/addition of the items entered.
• separatorKeys - [?number[]] - Array of keyboard keys with which is possible to define the key for separating terms. By default, only Enter is the defined key.
• transform - [?(item: string) => string] - a function that takes as argument the value of an item, and returns a string with the new value when appended. If the method returns null/undefined/false, the item gets rejected.
• validators - [?Validators[]] - an array of Validators (custom or Angular's) that will validate the tag before adding it to the list of items. It is possible to use multiple validators.

@Output

• onAdd - [?onAdd(item: string)] - event fired when an item has been added
• onRemove - [?onRemove(item: string)] - event fired when an item has been removed
• onSelect - [?onSelect(item: string)] - event fired when an item has been selected

Basic examples:

// example app

@Component({
    selector: 'app',
    directives: [TagInput],
    template: `<tag-input [(ngModel)]='items'></tag-input>`
});
export class App {
    items = ['Pizza', 'Pasta', 'Parmesan'];
    options = {
        placeholder: "+ term",
        secondaryPlaceholder: "Enter a new term",
        separatorKeys: [4, 5]
        maxItems: 10
    }
    onItemAdded(item) {
        console.log(``${item} has been added`)
    }
    onItemRemoved(item) {
        console.log(``${item} has been removed :(`)
    }
    // ...
}

// PROPERTIES
<tag-input [(ngModel)]='items'
           [placeholder]="options.placeholder"
           [secondaryPlaceholder]="options.secondaryPlaceholder"
           [maxItems]="options.maxItems"
           [separatorKeys]="options.separatorKeys">
</tag-input>

// EVENTS
<tag-input [(ngModel)]='items'
           (onRemove)="onItemRemoved($event)"
           (onAdd)="onItemAdded($event)">
</tag-input>


// CUSTOM TEMPLATES
// Input tag with a custom template

<tag-input [(ngModel)]='items' #input> // create a reference #input to the controller in order to use its API
    <div class='tag' *ngFor='let item of input.value'> // loop over the items
        <div class='tag__name'> {{ item }} </span> // display its values
        <span (click)="input.remove(item)">
            Remove me
        </span>
    </div>
</tag-input>

If you want to see more advanced examples, please have a look at http://www.webpackbin.com/VkRLliDHW.

What's next?

• Autocomplete