2.0 KiB
2.0 KiB
Highlight
Use this extension to render highlighted text with <mark>. You can use only default <mark> HTML tag, which has a yellow background color by default, or apply different colors.
Type ==two equal signs== and it will magically transform to highlighted text while you type.
Installation
# with npm
npm install @tiptap/extension-highlight
# with Yarn
yarn add @tiptap/extension-highlight
Settings
| Option | Type | Default | Description |
|---|---|---|---|
| multicolor | Boolean |
false |
Add support for multiple colors. |
| HTMLAttributes | Object |
{} |
Custom HTML attributes that should be added to the rendered HTML tag. |
Commands
| Command | Options | Description |
|---|---|---|
| setHighlight | color (optional) |
Mark text as highlighted. |
| toggleHighlight | color (optional) |
Toggle a text highlight. |
| unsetHighlight | — | Removes the highlight. |
Keyboard shortcuts
| Command | Windows/Linux | macOS |
|---|---|---|
| toggleHighlight() | Control Shift H |
Cmd Shift H |