angular2-mentions

Angular 2 Mentions

Simple Angular 2 mentions inspired by Ment.io.

Click here for a Demo

Provides auto-complete suggestions for @mentions in text input fields, text areas, and content editable fields. Not fully browser tested and comes without warranty!

To install and start the demo application:

git clone https://github.com/dmacfarlane/angular2-mentions.git
cd angular2-mentions
npm install
ng serve

Usage

Add the package as a dependency to your project using:

npm install --save angular2-mentions

Add the CSS to your index.html:

<link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css">

Add the module to your app.module imports:

import { MentionModule } from 'angular2-mentions/mention';
...

@NgModule({
    imports: [ MentionModule ],
    ...
})

Add the [mention] directive to your input element:

<input type="text" [mention]="items">

Where items is a string array of the items to suggest. For example:

items: string[] = ["Noah", "Liam", "Mason", "Jacob", ...

Options

• [triggerChar]="@" to specify the character that should trigger the menu behavior. The default value is '@'.
• [maxItems]="10" to limit the number of items shown in the pop-up menu. The default is no limit.
• [mentionSelect]="formatter" to specify a optional function to format the selected item before inserting the text.
• [labelKey]="'label'" to specify the field to be used as the item label (when the items are objects).
• [disableSearch]="true" to disable internal filtering (only useful if async search is used).
• (searchTerm)="" event emitted whenever the search term changes. Can be used to trigger async search.

TODO:

• Improve npm package structure
• Improve menu positioning
• Additional tests for options