Mention
Enable autocompletion for user mentions.
＠ Mention
Installation
npm install @udecode/plate-mention @udecode/plate-comboboxUsage
import { createComboboxPlugin } from '@udecode/plate-combobox';
import { createMentionPlugin } from '@udecode/plate-mention';
const plugins = [
// ...otherPlugins,
createComboboxPlugin(),
createMentionPlugin(),
];API
createMentionPlugin
Options
A function to create the mention node.
A unique ID for the mention plugin.
Whether to insert a space after the mention.
The character that triggers the mention (for example, '@' in the case of a user mention).
The pattern that matches the char before the trigger character
(default to /^\s?$/ that matches beginning of line or space)
An object containing the key-value pair for creating an input.
A query function to enable the behavior.
getMentionOnSelectItem
Gets the ComboboxOnSelectItem handler for selecting an item in the mention combobox.
Parameters
Returns
The ComboboxOnSelectItem handler for selecting an item in the mention
combobox.
findMentionInput
Finds the mention input node in the editor.
Parameters
The editor instance.
Additional options for finding the mention input node.
Returns
The mention input node entry if found, otherwise undefined.
isNodeMentionInput
Checks if a node is a mention input node in the editor.
Parameters
The editor instance.
The node to check.
Returns
true if the node is a mention input node, otherwise false.
isSelectionInMentionInput
Checks if the current selection in the editor is within a mention input.
Parameters
The editor instance.
Returns
true if the selection is within a mention input, otherwise false.
mentionOnKeyDownHandler
Handles keydown events for mention-related functionality, such as removing mention inputs and moving the selection by offset.
Parameters
Options for moving the selection by offset.
removeMentionInput
Removes the mention input node at the specified path.
Parameters
The editor instance.
The path of the mention input node to remove.