@techstacker/tse-strikethrough-plugin

5.2.0-alpha.273b0e7e • Public • Published
Nossas Cidades logo

@slate-editor/strikethrough-plugin

SlateJS strikethrough plugin.

npm package npm downloads

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
Apple Logo + ^ + s
Windows Logo 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

Package Sidebar

Install

npm i @techstacker/tse-strikethrough-plugin

Weekly Downloads

0

Version

5.2.0-alpha.273b0e7e

License

MIT

Unpacked Size

9.01 kB

Total Files

10

Last publish

Collaborators

  • kandelborg
  • techstacker-owner