Ngx Mention

Very simple Angular mentions inspired by Angular mentions

Provides auto-complete suggestions for @mentions in text input field and text area's

Demo

Demo is available here

Usage

Add the package as a dependency to your project using:

npm install @netcreaties/ngx-mention

yarn add @netcreaties/ngx-mention

Add the module to your app.module imports:

import { NgxMentionModule } from '@netcreaties/ngx-mention';
...

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

Add the [ncNgxMention] directive to your input or textarea element

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

Where items is a array of objects defined like the type NgxMentions NgxMentions is a simple type that maps your own given type into ngx-mention array type if you want it to.

An example of defining your own type is shown below:

    public ngxMentions: NgxMentions<type or interface of your choosing> = [];

Configuration options

The following configuration options are available

Option | Default | Description --- | --- | --- denotationCharacter | @ | Trigger on which the mention list is activated minimalCharacters | 0 | Minimal amount of characters before search is activated disableSearch | false | Set this to true for async search (using the search Output) dropUp | false | Mention list should be a drop up instead of dropdown formatSelected | item.value | Function to format selected item before inserting text

For example

<input type="text" [ncNgxMention]="items" [ngxMentionConfig]="{denotationCharacter: '$', minimalCharacters: 3}">

Custom templates

It is possible to add a custom template to change the way items are visible.

<ng-template #customTemplate let-item="item">
    {{ item.username }} {{ item.id }}
</ng-template>

<input
    type="text"
    [ncNgxMention]="[{id: 1, username: 'John'}, {id: 2, username: 'Doe'}]"
    [customTemplate]="{ template: customTemplate }"
/>

By default ngx-mention will expect a array structure defined like the interface NgxMention. By default ngx-mention will look to a property value which will parsed into the input or textarea.

You can alter this behavior by using the formatSelected configuration.

An example for the above structure would be:

interface OtherStructure {
    id: number,
    username: string
}

const configuration: NgxMentionConfig<OtherStructure> = {
    formatSelected: (item) => {
        // In here item will be typed as OtherStructure
        return item.username;
    }
}

Output events

Output | Description --- | --- @Output() searchTerm: EventEmitter<string> | Event that is emitted whenever the search term changes. Can be used to trigger async search. @Output() selectItem: EventEmitter<NgxMention> | Event that is emitted when an item is selected

Todo

• Extend demo-app to see code examples
• Add basic styles to demo-app to make it more presentable
• Add tests
• Add support for multiple denotation characters

Sites using this package

Are you using this package and do you want to be added to the list? Please create a pull request with your entry.

• Voetbalwedden
• Bettingfans