1.4 KiB
1.4 KiB
Strike
Use this extension to render striked text. If you pass <s>, <del>, <strike> tags, or text with inline style attributes setting text-decoration: line-through in the editor’s initial content, they all will be rendered accordingly.
Type ∼∼text between tildes∼∼ and it will be magically striked through while you type.
::: warning Restrictions
The extension will generate the corresponding <s> HTML tags when reading contents of the Editor instance. All text striked through, regardless of the method will be normalized to <s> HTML tags.
:::
Installation
# With npm
npm install @tiptap/extension-strike
# Or: With Yarn
yarn add @tiptap/extension-strike
Settings
| Option | Type | Default | Description |
|---|---|---|---|
| class | string | – | Add a custom class to the rendered HTML tag. |
Commands
| Command | Options | Description |
|---|---|---|
| strike | — | Mark text as strikethrough. |
Keyboard shortcuts
- Windows/Linux:
ControlD - macOS:
CmdD