Angular 2 Mentions
Simple Angular 2 mentions inspired by Ment.io.
Provides auto-complete suggestions for @mentions in text input fields, text areas, and content editable fields. Not fully browser tested and comes without warranty!
Support for many triggerChar in same input
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", ...
Use a string array, if you only have one triggerChar Use a array of array for multi trigger char
items: string[string[]] = [["Noah", "Liam", "Mason",...], ["Noah", "Liam", "Mason",...],....]
Index one is triggerChar at index one, Index two is triggerChar at index two and so on,...
Options
[mentionSelect]="formatter"to specify a optional function to format the selected item before inserting the text.[triggerChar]="@"to specify the character that should trigger the menu behavior. Can use multi triggerChar devide by comma (,). The default value is '@'. -- Acceptable input: "@, &, $" OR single character "@"
TODO:
- Improve npm package structure
- Improve menu positioning
- Configurable limit on number of items shown
- Load items via http service (configureable number of chars before search, and debounce requests)