https://github.com/editor-js/paragraph

Paragraph Tool for Editor.js 2.0
https://github.com/editor-js/paragraph

codex codex-editor editor paragraph plugin text

Last synced: about 2 months ago
JSON representation

Paragraph Tool for Editor.js 2.0

• Host: GitHub
• URL: https://github.com/editor-js/paragraph
• Owner: editor-js
• License: mit
• Created: 2017-09-01T04:10:38.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-08-04T19:49:03.000Z (5 months ago)
• Last Synced: 2024-11-10T13:47:09.139Z (2 months ago)
• Topics: codex, codex-editor, editor, paragraph, plugin, text
• Language: TypeScript
• Homepage:
• Size: 340 KB
• Stars: 44
• Watchers: 4
• Forks: 125
• Open Issues: 32
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-editorjs - @editorjs/paragraph

README

        
![](https://badgen.net/badge/Editor.js/v2.0/blue)

# Paragraph Tool for Editor.js

Basic text Tool for the [Editor.js](https://ifmo.su/editor).

## Installation

Get the package

```shell

yarn add @editorjs/paragraph

```

Include module at your application

```javascript

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`](https://editorjs.io/configuration#change-the-default-block)

option of the editor config.

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

```javascript

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 |

```json

{

    "type" : "paragraph",

    "data" : {

        "text" : "Check out our projects on a GitHub page.",

    }

}

```