Package Exports

@groupher/editor-strike

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@groupher/editor-strike) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Strike Tool

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

Installation

Install via NPM

Get the package

npm i --save-dev @editorjs/strike

Include module at your application

const Strike = require("@editorjs/strike");

Download to your project's source dir

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

Load from CDN

You can load specific version of package from jsDelivr CDN.

https://cdn.jsdelivr.net/npm/@editorjs/strike@1.0.1

Require this script on a page with Editor.js.

<script src="..."></script>

Usage

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

var editor = EditorJS({
  ...

  tools: {
    ...
    Strike: {
      class: Strike,
      shortcut: 'CMD+SHIFT+M',
    }
  },

  ...
});

Config Params

This Tool has no config params

Output data

Marked text will be wrapped with a mark tag with an cdx-strike class.

{
  "type": "text",
  "data": {
    "text": "Create a directory for your module, enter it and run <mark class=\"cdx-strike\">npm init</mark> command."
  }
}