SlateJS strikethrough plugin.

Installation

The @slate-editor/strikethrough-plugin is available as an npm package.

yarn add @slate-editor/strikethrough-plugin

Usage

Here is a quick example to get you started:

import React from 'react'
import { SlateEditor, SlateToolbar, SlateContent } from 'slate-editor'
import { StrikethroughPlugin, StrikethroughButton } from '@slate-editor/strikethrough-plugin'

const plugins = [
  StrikethroughPlugin()
]

const SlateRichTextEditor = () => (
  <SlateEditor plugins={plugins}>
    <SlateToolbar>
      <StrikethroughButton />
    </SlateToolbar>

    <SlateContent />
  </SlateEditor>
)

export default SlateRichTextEditor

Keyboard Shortcut

| OS | Shortcut | |--------------------------|-------------------------------------------------| | | ⌘ + ^ + s | | | ctrl + alt + s |

API

| Name | Description | |-------------------------------|------------------------------------------------------------------------------------| | StrikethroughMark | Component that holds the html that will wrap the content with strikethrough style. | | StrikethroughKeyboardShortcut | Keyboard shortcut file that manipulates onKeyDown event inside SlateJS. | | StrikethroughUtils | Generic file that holds the util common functions. | | StrikethroughButton | Button component that have behaviour to wrap content with strikethrough style. |

TODO

• Make keyboard shortcut accepts customization