Files
tiptap/docs/src/docPages/api/extensions/strike.md
2020-09-10 12:31:26 +02:00

1.2 KiB
Raw Blame History

Strike

This extension is used 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.

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. :::

Options

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: Control + D
  • macOS: Command + D

Source Code

packages/extension-strike/

Usage