editorjs-strikethrough

Strikethrough Tool

Strikethrough Tool for marking text-fragments for the Editor.js.

Installation

Install via NPM

Get the package

npm i --save-dev editorjs-strikethrough

Include module at your application

const Strikethrough = require('editorjs-strikethrough');

Download to your project's source dir

1. Upload folder dist from repository
2. Add dist/bundle.js file to your page.

Usage

Add a new Tool to the tools property of the Editor.js initial config.

var editor = EditorJS({
  ...
  
  tools: {
    ...
    strikethrough: {
      class: Strikethrough,
      shortcut: 'CMD+SHIFT+X',
    },
  },
  
  ...
});

Config Params

This Tool has no config params

Output data

Marked text will be wrapped with a del tag with an cdx-strikethrough class.

{
    "type" : "text",
    "data" : {
        "text" : "This is <del class='cdx-strikethrough'>test</del> text."
    }
}