CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Interface

MentionConfig (mention)

@ckeditor/ckeditor5-mention/src/mention

interface
See source

The configuration of the mention feature.

Read more about configuring the mention feature.

ClassicEditor
    .create( editorElement, {
        mention: ... // Mention feature options.
    } )
    .then( ... )
    .catch( ... );

See all editor options.

Filtering

Properties

  • feeds : Array.<MentionFeed>

    The list of mention feeds supported by the editor.

    See source
    ClassicEditor
    .create( editorElement, {
        plugins: [ Mention, ... ],
        mention: {
            feeds: [
                {
                    marker: '@',
                    feed: [ '@Barney', '@Lily', '@Marshall', '@Robin', '@Ted' ]
                },
                ...
            ]
        }
    } )
    .then( ... )
    .catch( ... );

    You can provide many mention feeds but they must use different markers. For example, you can use '@' to autocomplete people and '#' to autocomplete tags.