Skip to content

Latest commit

 

History

History
53 lines (32 loc) · 1.43 KB

README.md

File metadata and controls

53 lines (32 loc) · 1.43 KB
Raw

Angular 2 Mentions

Simple Angular 2 mentions inspired by Ment.io.

Click here for a Demo

Provides auto-complete 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

Install the package as a dependency using:

npm install --save angular2-mentions

Add the CSS to your index.html:

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

Add the module to your module imports:

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

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

Add the [mention] directive to your input element:

<input [mention]="items" class="form-control" type="text">

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

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

Options

  • [triggerChar]="@" to specify the trigger char

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)