tiptap/docs/api/marks/strike.md

# Strike
[![Version](https://img.shields.io/npm/v/@tiptap/extension-strike.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-strike)
[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-strike.svg)](https://npmcharts.com/compare/@tiptap/extension-strike?minimal=true)

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 <code>&Tilde;&Tilde;text between tildes&Tilde;&Tilde;</code> 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
```bash
# with npm
npm install @tiptap/extension-strike

# with Yarn
yarn add @tiptap/extension-strike
```

## Settings
| Option         | Type     | Default | Description                                                           |
| -------------- | -------- | ------- | --------------------------------------------------------------------- |
| HTMLAttributes | `Object` | `{}`    | Custom HTML attributes that should be added to the rendered HTML tag. |

## Commands

### setStrike()
Mark text as striked.

```js
editor.commands.setStrike()
```

### toggleStrike()
Toggle strike mark.

```js
editor.commands.toggleStrike()
```

### unsetStrike()
Remove strike mark.

```js
editor.commands.unsetStrike()
```

## Keyboard shortcuts
| Command        | Windows/Linux                   | macOS                       |
| -------------- | ------------------------------- | --------------------------- |
| toggleStrike() | `Control`&nbsp;`Shift`&nbsp;`X` | `Cmd`&nbsp;`Shift`&nbsp;`X` |

## Source code
[packages/extension-strike/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-strike/)

## Usage
<tiptap-demo name="Marks/Strike"></tiptap-demo>
-												move all extensions to separate pages

											
										
										
											2020-08-19 03:39:41 +08:00
+								# Strike
-												docs: add badges to all extensions

											
										
										
											2021-01-25 17:35:52 +08:00
+								[![Version](https://img.shields.io/npm/v/@tiptap/extension-strike.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-strike)
 								[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-strike.svg)](https://npmcharts.com/compare/@tiptap/extension-strike?minimal=true)
-												add an interactive demo and tests to the underline extension

											
										
										
											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’s initial content, they all will be rendered accordingly.
-												add the strike extension documentation

											
										
										
											2020-09-10 17:53:03 +08:00
-												change markdown shortcut for striked text to two tildes

											
										
										
											2020-10-02 21:05:26 +08:00
+								Type <code>&Tilde;&Tilde;text between tildes&Tilde;&Tilde;</code> and it will be magically ~~striked through~~ while you type.
-												add the strike extension documentation

											
										
										
											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.
 								:::
-												move all extensions to separate pages

											
										
										
											2020-08-19 03:39:41 +08:00
-												add installation instructions to all extensions

											
										
										
											2020-09-23 15:52:04 +08:00
+								## Installation
 								```bash
-												update content

											
										
										
											2020-10-30 21:24:16 +08:00
+								# with npm
-												add installation instructions to all extensions

											
										
										
											2020-09-23 15:52:04 +08:00
+								npm install @tiptap/extension-strike
-												update content

											
										
										
											2020-10-30 21:24:16 +08:00
+								# with Yarn
-												add installation instructions to all extensions

											
										
										
											2020-09-23 15:52:04 +08:00
+								yarn add @tiptap/extension-strike
 								```
-												a ton of improvements

											
										
										
											2020-09-23 18:03:03 +08:00
+								## Settings
-												docs: add HTMLAttributes

											
										
										
											2020-11-18 19:12:34 +08:00
+								| Option         | Type     | Default | Description                                                           |
 								| -------------- | -------- | ------- | --------------------------------------------------------------------- |
 								| HTMLAttributes | `Object` | `{}`    | Custom HTML attributes that should be added to the rendered HTML tag. |
-												move all extensions to separate pages

											
										
										
											2020-08-19 03:39:41 +08:00
-												improve the extensions documentation

											
										
										
											2020-08-20 21:33:16 +08:00
+								## Commands
-												docs: make all mark commands a list

											
										
										
											2021-10-02 05:25:07 +08:00
 								### setStrike()
 								Mark text as striked.
 								```js
 								editor.commands.setStrike()
 								```
 								### toggleStrike()
 								Toggle strike mark.
 								```js
 								editor.commands.toggleStrike()
 								```
 								### unsetStrike()
 								Remove strike mark.
 								```js
 								editor.commands.unsetStrike()
 								```
-												move all extensions to separate pages

											
										
										
											2020-08-19 03:39:41 +08:00
-												rename keybindings to keyboard shortcuts

											
										
										
											2020-09-10 17:24:33 +08:00
+								## Keyboard shortcuts
-												docs: make the mark keyboard shortcuts a table

											
										
										
											2021-10-02 05:04:47 +08:00
+								| Command        | Windows/Linux                   | macOS                       |
 								| -------------- | ------------------------------- | --------------------------- |
 								| toggleStrike() | `Control`&nbsp;`Shift`&nbsp;`X` | `Cmd`&nbsp;`Shift`&nbsp;`X` |
-												move all extensions to separate pages

											
										
										
											2020-08-19 03:39:41 +08:00
-												minor improvements

											
										
										
											2020-09-21 22:59:28 +08:00
+								## Source code
-												replace link to GitHub repository

											
										
										
											2021-04-21 21:31:11 +08:00
+								[packages/extension-strike/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-strike/)
-												move all extensions to separate pages

											
										
										
											2020-08-19 03:39:41 +08:00
-												add the strike extension documentation

											
										
										
											2020-09-10 17:53:03 +08:00
+								## Usage
-												replace demo component with custom element

											
										
										
											2021-08-26 05:10:20 +08:00
+								<tiptap-demo name="Marks/Strike"></tiptap-demo>