探索 Tiptap V3 的最新功能

建议工具

版本下载量

此工具帮助处理编辑器中的各种建议。查看 MentionEmoji 节点以查看其实际效果。

设置

char

触发自动补全弹出窗口的字符。

默认:'@'

pluginKey

一个 ProseMirror PluginKey。

默认:SuggestionPluginKey

allow

一个返回布尔值的函数,指示建议是否应处于活动状态。

默认:(props: { editor: Editor; state: EditorState; range: Range, isActive?: boolean }) => true

allowSpaces

允许或不允许建议项目中出现空格。

默认:false

allowedPrefixes

允许触发建议的前缀字符。设置为 null 以允许任何前缀字符。

默认:[' ']

startOfLine

仅在行首触发自动补全弹出窗口。

默认:false

decorationTag

应为建议呈现的 HTML 标签。

默认:'span'

decorationClass

应添加到建议的 CSS 类。

默认: 'suggestion'

decorationContent

应在建议装饰中呈现的内容。

默认: ''

decorationEmptyClass

当建议为空时应添加的 CSS 类。

默认: 'is-empty'

command

选择建议时执行的操作。

默认:() => {}

items

传递一个过滤后的建议数组,可以是异步的。

默认:({ editor, query }) => []

render

自动补全弹出窗口的渲染函数。

默认:() => ({})

findSuggestionMatch

可选参数,用于替换触发建议的编辑器内容内置正则匹配。 有关更多详细信息,请参见 源代码

默认:findSuggestionMatch(config: Trigger): SuggestionMatch

源代码

packages/suggestion/