Suggestion utility
This utility helps with all kinds of suggestions in the editor. Have a look at the Mention or Emoji node to see it in action.
Settings
char
The character that triggers the autocomplete popup.
Default: '@'
pluginKey
A ProseMirror PluginKey.
Default: SuggestionPluginKey
allow
A function that returns a boolean to indicate if the suggestion should be active.
Default: (props: { editor: Editor; state: EditorState; range: Range, isActive?: boolean }) => true
allowSpaces
Allows or disallows spaces in suggested items.
Default: false
allowedPrefixes
The prefix characters that are allowed to trigger a suggestion. Set to null to allow any prefix character.
Default: [' ']
startOfLine
Trigger the autocomplete popup at the start of a line only.
Default: false
decorationTag
The HTML tag that should be rendered for the suggestion.
Default: 'span'
decorationClass
A CSS class that should be added to the suggestion.
Default: 'suggestion'
command
Executed when a suggestion is selected.
Default: () => {}'
items
Pass an array of filtered suggestions, can be async.
Default: ({ editor, query }) => []
render
A render function for the autocomplete popup.
Default: () => ({})
findSuggestionMatch
Optional param to replace the built-in regex matching of editor content that triggers a suggestion. See the source for more detail.
Default: findSuggestionMatch(config: Trigger): SuggestionMatch