@angular2plus/angular-mentions v1.3.5

Angular Mentions

Simple Angular mentions inspired by Ment.io.

Special thanks to angular-mentions.

Click here for a Demo

Provides auto-complete suggestions for @mentions in text input fields, text areas, and content editable fields.

To install and start the demo application:

git clone https://github.com/isfandkhan/angular-mentions.git
cd angular-mentions
npm install
ng serve

Usage

Add the package as a dependency to your project using:

npm i @angular2plus/angular-mentions

Add the module to your app.module imports:

import { MentionModule } from '@angular2plus/angular-mentions';
...

@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 | | | | items | | An array of strings or objects to suggest. | triggerChar | @ | The character that will trigger the menu behavior. | labelKey | label | The field to be used as the item label (when the items are objects). | disableSort | false | Disable sorting of suggested items. | disableSearch | false | Disable internal filtering (only useful if async search is used). | dropUp | false | Show the menu above the cursor instead of below. | maxItems | ∞ | Limit the number of items shown in the text. The default is no limit. | mentionSelect | | A function to format the selected item before inserting the text. | allowSpace | false | Allow spaces while mentioning. | returnTrigger | false | Include the trigger char in the searchTerm event. | mentionListTemplate | null | Include the trigger char in the searchTerm event.

For Example:

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

Output Events

The following output events can be used.

| Output | Description | | | @Output() searchTerm EventEmitter<string> | Event that is emitted whenever the search term changes. Can be used to trigger async search. | @Output() opened EventEmitter<void> | Event that is emitted when the mentions panel is opened. | @Output() closed EventEmitter<void> | Event that is emitted when the mentions panel is closed.

Alternative Usage

The component can also be used by only specifying the mentionConfig object:

<input type="text" [mentionConfig]="mentionConfig">

With the following structure:

let mentionConfig = {
    items: [ "Noah", "Liam", "Mason", "Jacob", ... ],
    triggerChar: "@",
    ...
}

In this way, multiple config objects can be used:

let mentionConfig = {
    mentions: [
        {
            items: [ "Noah", "Liam", "Mason", "Jacob", ... ],
            triggerChar: '@'
        },
        {
            items: [ "Red", "Yellow", "Green", ... ],
            triggerChar: '#'
        },
    }]
}

This allows different lists and trigger characters to be configured.

Note that because objects are mutable, changes to the items within the config will not be picked up unless a new mentionConfig object is created.

CUSTOM Template

Custom HTML can also be injected, bypassing the default HTML template provided by @angular2plus/angular-mentions.

let mentionConfig = {
    items: [ "Noah", "Liam", "Mason", "Jacob", ...],
    data: [
      { imgUrl: 'Some Image URL' },
      { imgUrl: 'Some Image URL' },
      { imgUrl: 'Some Image URL' },
      ...
    ],
    triggerChar: "@",
    ...
}

<ng-template #mentionList let-item="item">
  
  <img [src]="item.data.imgUrl">
  {{ item.label }}
  
</ng-template>

<input type="text" [mentionListTemplate]="mentionList" [mentionConfig]="mentionConfig">