NEWCKEditor 5 Long-term Support is here! Find out more
Sign up (with export icon)

MentionFeed

Api-interface icon interface

The mention feed descriptor. Used in config.mention.

See MentionConfig to learn more.

// Static configuration.
const mentionFeedPeople = {
	marker: '@',
	feed: [ '@Alice', '@Bob', ... ],
	minimumCharacters: 2
};

// Simple synchronous callback.
const mentionFeedTags = {
	marker: '#',
	feed: ( searchString: string ) => {
		return tags
			// Filter the tags list.
			.filter( tag => {
				return tag.toLowerCase().includes( queryText.toLowerCase() );
			} )
	}
};

const tags = [ 'wysiwyg', 'rte', 'rich-text-edior', 'collaboration', 'real-time', ... ];

// Asynchronous callback.
const mentionFeedPlaceholders = {
	marker: '
Copy code
, feed: ( searchString: string ) => { return getMatchingPlaceholders( searchString ); } }; function getMatchingPlaceholders( searchString: string ) { return new Promise<Array<MentionFeedItem>>( resolve => { doSomeXHRQuery( result => { // console.log( result ); // -> [ '$name', '$surname', '$postal', ... ] resolve( result ); } ); } ); }
Copy code
See source (with github icon)

Properties

Was this page helpful?

Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.

GitHubSupportContact Us

© 2003 - 2025  CKSource. All rights reserved.