探索 Tiptap V3 的最新功能

高亮扩展

版本下载量

使用此扩展通过 <mark> 渲染高亮文本。您可以仅使用默认的 <mark> HTML 标签,该标签的默认背景颜色为黄色,或者应用不同的颜色。

输入 ==两个等号==,它会在您输入时神奇地转换为 高亮 文本。

安装

npm install @tiptap/extension-highlight

设置

HTMLAttributes

应添加到渲染的 HTML 标签中的自定义 HTML 属性。

Highlight.configure({
  HTMLAttributes: {
    class: 'my-custom-class',
  },
})

multicolor

添加对多种颜色的支持。

默认: false

Highlight.configure({
  multicolor: true,
})

命令

setHighlight()

将文本标记为高亮。

editor.commands.setHighlight()
editor.commands.setHighlight({ color: '#ffcc00' })

toggleHighlight()

切换文本高亮。

editor.commands.toggleHighlight()
editor.commands.toggleHighlight({ color: '#ffcc00' })

unsetHighlight()

移除高亮。

editor.commands.unsetHighlight()

快捷键

命令Windows/LinuxmacOS
toggleHighlight()Control + Shift + HCmd + Shift + H

源代码

packages/extension-highlight/