1.0.13 • Published 2 years ago

editorjs-paragraph-tools v1.0.13

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

npm.io

Paragraph Tools for Editor.js

image

Installation

Install via NPM

Get the package

npm i --save editorjs-paragraph-tools

Include module at your application

const Paragraph = require('editorjs-paragraph-tools');

Download to your project's source dir

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

Usage

The Paragraph tool is included at editor.js by default, so you don't need to connect it manually. If you want to connect your customized version of this tool, do not forget to use the initialBlock option of the editor config.

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

var editor = EditorJS({
  ...

  tools: {
    ...
    paragraph: {
      class: Paragraph,
      inlineToolbar: true,
    },
  }

  ...
});

Config Params

The Paragraph Tool supports these configuration parameters:

FieldTypeDescription
placeholderstringThe placeholder. Will be shown only in the first paragraph when the whole editor is empty.
preserveBlankboolean(default: false) Whether or not to keep blank paragraphs when saving editor data

Output data

FieldTypedefaultDescription
textstringparagraph's text
alignmentstringleftleft/center/right/justify
lineHeightnumber1.60.2 - 3
{
    "type" : "paragraph",
    "data" : {
        "text" : "Check out our projects on a <a href=\"https://github.com/codex-team\">GitHub page</a>.",
        "alignment": "left",
        "lineHeight": 1.6
    }
}