Angular Mentions

Simple Angular 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/angular-mentions.git
cd angular-mentions
npm install
ng serve

Usage

Add the package as a dependency to your project using:

npm install --save angular-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 'angular-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", ...

Configuration Options

The following optional configuration items can be used.

Option	Default	Description
triggerChar	@	The character that will trigger the menu behavior.
maxItems		Limit the number of items shown in the pop-up menu. The default is no limit.
insertHTML	false	Insert HTML instead of plain text.
mentionSelect		An optional function to format the selected item before inserting the text. Use this function to create HTML.
labelKey	label	The field to be used as the item label (when the items are objects).
disableSearch	false	Disable internal filtering (only useful if async search is used).

Options Example:

<input type="text" [mention]="items" [mentionConfig]="{triggerChar:'#',maxItems:10,labelKey:'name'}">

HTML Element Example:

<div
    [mention]="items"
    [mentionConfig]="{
        insertHTML: true,
        mentionSelect: insertSpanElement
    }"
    class="form-control"
    contenteditable="true"
    style="border:1px lightgrey solid;min-height:88px"></div>

/**
 * Note: There is no way to add a trailing space after this span.
 * There will be useability consequences.
 */
public insertSpanElement(name) {
    let el = document.createElement("span");
    el.contentEditable = "false";
    el.className = "mention";
    el.innerText = `@${name.label}`;
    return el;
}

HTML Code Example:

<div
    [mention]="items"
    [mentionConfig]="{
        insertHTML: true,
        mentionSelect: insertSpanText
    }"
    class="form-control"
    contenteditable="true"
    style="border:1px lightgrey solid;min-height:88px"></div>

/**
 * Note the trailig &nbsp;.
 * It helps with useability.
 */
public insertSpanText(name) {
    return `
    <span
        class="mention"
        contenteditable="false"
        >@${name.label}</span>&nbsp;
    `;
}

Output Events

• (searchTerm)="" event emitted whenever the search term changes. Can be used to trigger async search.