editor-js-paragraph-extended
v1.2.1
Published
Paragraph Tool for Editor.js
Downloads
209
Maintainers
Readme
Yet Another Paragraph Tool for Editor.js
Basic text Tool for the Editor.js.
Installation
Install via NPM
Get the package
npm i --save editor-js-paragraph-extended
Include module at your application
const Paragraph = require('editor-js-paragraph-extended');
Or
import Paragraph from 'editor-js-paragraph-extended';
Usage
The Paragraph tool is included at editor.js by default. So you don't need to connect it manually.
To connect 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.
const ParagraphEx = require('editor-js-paragraph-extended');
var editor = EditorJS({
tools: {
paragraphExtended: {
class: ParagraphEx,
inlineToolbar: true,
},
},
defaultBlock: 'paragraphExtended'
})
;
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
| paragraph's alignment |
{
"type": "paragraph",
"data": {
"text": "Check out our projects on a <a href=\"https://github.com/codex-team\">GitHub page</a>.",
"alignment": "left"
}
}