UNPKG

756 BMarkdownView Raw
1# @canner/slate-icon-strikethrough
2
3[![npm version](https://badge.fury.io/js/%40canner%2Fslate-icon-strikethrough.svg)](https://badge.fury.io/js/%40canner%2Fslate-icon-strikethrough)
4
5## Icon
6
7```js
8import Strikethrough from '@canner/slate-icon-strikethrough';
9```
10
11#### Props
12
13- **type:** Mark type name. Default: `STRIKETHROUGH`
14
15## Plugin
16
17```js
18import {StrikeThroughPlugin} from '@canner/slate-icon-strikethrough';
19
20// this will add render method for this mark, and also support hot key for strikethrough.
21const plugins = [
22 StrikeThroughPlugin(options)
23]
24```
25
26#### Hot key
27
28<kbd>Ctrl</kbd>+<kbd>Opt</kbd>+<kbd>d</kbd>
29
30#### Options
31
32- **type:** Mark type name. Default: `STRIKETHROUGH`
33- **tagName:** Rendered tagName in this plugin. Default `<s/>`
34