# @editorjs/paragraph

> Paragraph Tool for Editor.js

Latest version **2.11.7** (published 2024-12-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install @editorjs/paragraph
pnpm add @editorjs/paragraph
yarn add @editorjs/paragraph
bun add @editorjs/paragraph
```

## Health

**Score 35/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.11.7 |
| Published | 2024-12-16 |
| First published | 2019-03-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 17.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 59 |
| Author | CodeX |
| Maintainers | codex-team |
| Keywords | codex editor, paragraph, editor.js, editorjs |

## Links

- npm: https://www.npmjs.com/package/@editorjs/paragraph
- Repository: https://github.com/editor-js/paragraph
- npm.io page: https://npm.io/package/@editorjs/paragraph

## Dependencies (1)

- [@codexteam/icons](https://npm.io/package/@codexteam/icons.md) ^0.0.4

## Alternatives

- [d3-force-3d](https://npm.io/package/d3-force-3d.md) — 1.0M weekly downloads
- [ng2-charts](https://npm.io/package/ng2-charts.md) — 486.8K weekly downloads
- [@arcgis/core](https://npm.io/package/@arcgis/core.md) — 257.8K weekly downloads
- [react-sparklines](https://npm.io/package/react-sparklines.md) — 249.3K weekly downloads
- [react-native-gifted-charts](https://npm.io/package/react-native-gifted-charts.md) — 182.3K weekly downloads

## Recent versions

- 2.11.7 (latest) — 2024-12-16
- 3.0.0 (next) — 2026-07-13
- 2.11.6 — 2024-07-03
- 2.11.5 — 2024-06-12
- 2.11.4 — 2024-03-30
- 2.11.3 — 2023-10-18
- 2.11.2 — 2023-10-17
- 2.11.1 — 2023-10-17
- 2.10.0 — 2023-08-01
- 2.9.0 — 2022-11-29
- 2.8.0 — 2020-10-01
- 2.7.0 — 2020-06-06
- 2.6.1 — 2019-11-30
- 2.6.0 — 2019-07-01
- 2.5.1 — 2019-06-12
- … 2 more at https://npm.io/package/@editorjs/paragraph/versions

## 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 <a href=\"https://github.com/codex-team\">GitHub page</a>.",
    }
}
```

---
_Source: https://npm.io/package/@editorjs/paragraph · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._