tiptap/docs/api/marks/strike.md

73 lines
2.0 KiB
Markdown
Raw Normal View History

---
2021-10-16 04:48:57 +08:00
description: Cut through the words you wrote if youre too afraid to delete it.
2021-10-15 03:20:21 +08:00
icon: strikethrough
---
2020-08-19 03:39:41 +08:00
# Strike
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)
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 editors initial content, they all will be rendered accordingly.
2020-09-10 17:53:03 +08:00
Type <code>&Tilde;&Tilde;text between tildes&Tilde;&Tilde;</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
## Installation
```bash
2020-10-30 21:24:16 +08:00
# with npm
npm install @tiptap/extension-strike
2020-10-30 21:24:16 +08:00
# with Yarn
yarn add @tiptap/extension-strike
```
2020-09-23 18:03:03 +08:00
## Settings
### HTMLAttributes
Custom HTML attributes that should be added to the rendered HTML tag.
```js
Strike.configure({
HTMLAttributes: {
class: 'my-custom-class',
},
})
```
2020-08-19 03:39:41 +08:00
2020-08-20 21:33:16 +08:00
## Commands
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()
```
2020-08-19 03:39:41 +08:00
## Keyboard shortcuts
| Command | Windows/Linux | macOS |
| -------------- | ------------------------------- | --------------------------- |
| toggleStrike() | `Control`&nbsp;`Shift`&nbsp;`X` | `Cmd`&nbsp;`Shift`&nbsp;`X` |
2020-08-19 03:39:41 +08:00
2020-09-21 22:59:28 +08:00
## Source code
2021-04-21 21:31:11 +08:00
[packages/extension-strike/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-strike/)
2020-08-19 03:39:41 +08:00
2020-09-10 17:53:03 +08:00
## Usage
2021-10-19 00:01:47 +08:00
https://embed.tiptap.dev/preview/Marks/Strike