2020-08-19 03:39:41 +08:00
# Strike
2020-09-10 18:43:40 +08:00
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’
2020-09-10 17:53:03 +08:00
2020-10-02 21:05:26 +08:00
Type < code > ∼∼ text between tildes∼∼ </ code > and it will be magically ~~striked through~~ while you type.
2020-09-10 17:53:03 +08:00
::: 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.
:::
2020-08-19 03:39:41 +08:00
2020-09-23 15:52:04 +08:00
## Installation
```bash
2020-10-30 21:24:16 +08:00
# with npm
2020-09-23 15:52:04 +08:00
npm install @tiptap/extension -strike
2020-10-30 21:24:16 +08:00
# with Yarn
2020-09-23 15:52:04 +08:00
yarn add @tiptap/extension -strike
```
2020-09-23 18:03:03 +08:00
## Settings
2020-09-10 16:21:24 +08:00
| Option | Type | Default | Description |
| ------ | ------ | ------- | -------------------------------------------- |
| class | string | –
2020-08-19 03:39:41 +08:00
2020-08-20 21:33:16 +08:00
## Commands
2020-09-10 16:21:24 +08:00
| Command | Options | Description |
| ------- | ------- | --------------------------- |
| strike | — | Mark text as strikethrough. |
2020-08-19 03:39:41 +08:00
2020-09-10 17:24:33 +08:00
## Keyboard shortcuts
2020-09-27 17:01:25 +08:00
* Windows/Linux: `Control` `D`
* macOS: `Cmd` `D`
2020-08-19 03:39:41 +08:00
2020-09-21 22:59:28 +08:00
## Source code
2020-09-10 17:53:03 +08:00
[packages/extension-strike/ ](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-strike/ )
2020-08-19 03:39:41 +08:00
2020-09-10 17:53:03 +08:00
## Usage
< demo name = "Extensions/Strike" highlight = "3-5,17,36" / >
