@lostlink/blade

Blade Tool for Editor.js

Blade Tool for the Editor.js.

Installation

Install via NPM

Get the package

npm i --save @editorjs/blade

Include module at your application

const Blade = require('@editorjs/blade');

Download to your project's source dir

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

Load from CDN

You can also load specific version of package from jsDelivr CDN.

https://cdn.jsdelivr.net/npm/@editorjs/blade@1.0.0

Then require this script on 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: {
    ...
    blade: {
      class: Blade,
      inlineToolbar: true,
    },
  }

  ...
});

Config Params

The Blade Tool supports these configuration parameters:

Field	Type	Description
placeholder	string	The placeholder. Will be shown only in the first paragraph when the whole editor is empty.
preserveBlank	boolean	(default: false) Whether or not to keep blank paragraphs when saving editor data

Output data

Field	Type	Description
text	string	blade's text

{
    "type" : "blade",
    "data" : {
        "text" : "Check out EditorJS projects on their <a href=\"https://github.com/codex-team\">GitHub page</a>.",
    }
}