Skip to content
List Tool for Editor.js 2.0
Branch: master
Clone or download
Latest commit 019fe76 Apr 7, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets Add bundle, improve current item search, update gif Apr 7, 2019
dist pull master Apr 7, 2019
src pull master Apr 7, 2019
.gitignore initial version Jul 31, 2018
.npmignore Feature/renaming (#11) Mar 2, 2019
LICENSE initial version Jul 31, 2018
README.md Feature/renaming (#11) Mar 2, 2019
package.json
webpack.config.js Update styles Mar 10, 2019
yarn.lock Update styles Mar 10, 2019

README.md

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

  1. Upload folder dist from repository
  2. 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 type.

Output data

Field Type Description
style string type of list: ordered or unordered
items string[] array of list's items
{
    "type" : "list",
    "data" : {
        "style" : "unordered",
        "items" : [
            "This is a block-styled editor",
            "Clean output data",
            "Simple and powerful API"
        ]
    }
},
You can’t perform that action at this time.