Skip to content

editor-js/paragraph

Folders and files

NameName
Last commit message
Last commit date

Latest commit

5da9af3 · Dec 16, 2024
Nov 13, 2023
Jul 3, 2024
Jul 3, 2024
Jun 8, 2024
Jul 30, 2018
Oct 16, 2023
Jul 30, 2018
Jan 21, 2024
Oct 9, 2024
Jun 3, 2024
Jun 3, 2024
Jun 29, 2019
Jun 3, 2024

Repository files navigation

Paragraph Tool for Editor.js

Basic text Tool for the Editor.js.

Installation

Get the package

yarn add @editorjs/paragraph

Include module at your application

import Paragraph from '@editorjs/paragraph';

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 defaultBlock option of the editor config.

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

var editor = new 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
{
    "type" : "paragraph",
    "data" : {
        "text" : "Check out our projects on a <a href=\"https://github.com/codex-team\">GitHub page</a>.",
    }
}