mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-12-05 04:19:07 +08:00
71 lines
1.8 KiB
Markdown
71 lines
1.8 KiB
Markdown
# Suggestion
|
|
[](https://www.npmjs.com/package/@tiptap/suggestion)
|
|
[](https://npmcharts.com/compare/@tiptap/suggestion?minimal=true)
|
|
|
|
This utility helps with all kinds of suggestions in the editor. Have a look at the [`Mention`](/api/nodes/mention) or [`Emoji`](/api/nodes/emoji) node to see it in action.
|
|
|
|
## Settings
|
|
|
|
### char
|
|
The character that triggers the autocomplete popup.
|
|
|
|
Default: `'@'`
|
|
|
|
### pluginKey
|
|
A ProseMirror PluginKey.
|
|
|
|
Default: `SuggestionPluginKey`
|
|
|
|
### 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](https://github.com/estrattonbailey/tiptap/blob/develop/packages/suggestion/src/findSuggestionMatch.ts#L18)
|
|
for more detail.
|
|
|
|
Default: `findSuggestionMatch(config: Trigger): SuggestionMatch`
|
|
|
|
|
|
## Source code
|
|
[packages/suggestion/](https://github.com/ueberdosis/tiptap/blob/main/packages/suggestion/)
|
|
|