tiptap/docs/src/docPages/api/marks/strike.md

40 lines
1.6 KiB
Markdown
Raw Normal View History

2020-08-19 03:39:41 +08:00
# 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 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
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. |
2020-08-19 03:39:41 +08:00
2020-08-20 21:33:16 +08:00
## Commands
2020-12-04 00:05:22 +08:00
| Command | Parameters | Description |
| ------------ | ---------- | --------------------- |
| setStrike | — | Mark text as striked. |
| toggleStrike | — | Toggle strike mark. |
| unsetStrike | — | Remove strike mark. |
2020-08-19 03:39:41 +08:00
## Keyboard shortcuts
2020-11-19 08:16:10 +08:00
* Windows/Linux: `Control`&nbsp;`Shift`&nbsp;`X`
* macOS: `Cmd`&nbsp;`Shift`&nbsp;`X`
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="Marks/Strike" highlight="3-5,17,36" />