List Tool for Editor.js
This Tool for the Editor.js allows you to add ordered or unordered (bulleted) lists to your article.
Installation
Install via NPM
Get the package
npm i --save-dev @editorjs/list
Include module at your application
const List = require("@editorjs/list");
Download to your project's source dir
- Upload folder
dist
from repository - Add
dist/bundle.js
file to your page.
Load from CDN
You can load specific version of package from jsDelivr CDN.
https://cdn.jsdelivr.net/npm/@editorjs/list@1.0.2
Then require this script on page with Editor.js.
<script src="..."></script>
Usage
Add a new Tool to the tools
property of the Editor.js initial config.
var editor = EditorJS({
...
tools: {
...
list: {
class: List,
inlineToolbar: true,
},
}
...
});
Config Params
This Tool has no config params
Tool's settings
You can choose list`s mode.
Output data
Field | Type | Description |
---|---|---|
style | string |
mode of list: ordered or unordered or checklist
|
items | string[] |
array of list's items |
{
"type" : "list",
"data" : {
"mode" : "unordered",
"items" : [
"This is a block-styled editor",
"Clean output data",
"Simple and powerful API"
]
}
},