weekwood/paragraph-with-alignment

Paragraph Tool for Editor.js 2.0

Paragraph Tool with alignment for Editor.js

If you can help, please push the Star button :)

If you want to add an alignment to another block

This is useful editorjs-alignment-blocktune

versions

version	Description
@2.x	support alignment left/center/right
@3.x	support alignment left/center/right/justify

Installation

Install via NPM

Get the package

npm i --save editorjs-paragraph-with-alignment@3.x

Include module at your application

const Paragraph = require('editorjs-paragraph-with-alignment');

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

https://cdn.jsdelivr.net/npm/editorjs-paragraph-with-alignment@3.0.0

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:

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	paragraph's text
alignment	string	left/center/right/justify

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