Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@itech-indrustries/editorjs-strikethrough

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

codex, editor, strikethrough, tool, editor.js, editorjs

readme

Strikethrough Tool

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

Installation

Install via NPM

Get the package

npm i @itech-indrustries/editorjs-strikethrough

Include module at your application

const Strikethrough = require('@itech-indrustries/editorjs-strikethrough');

install via CDN

  <script src="https://cdn.jsdelivr.net/npm/@itech-indrustries/editorjs-strikethrough@latest"></script>

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: Strikethrough,
  },

  ...
});

Config Params

This Tool has no config params

Output data

Marked text will be wrapped with a s tag.

{
    "type" : "text",
    "data" : {
        "text" : "Create a directory for your module, enter it and run <s>npm init</s> command."
    }
}