nested-list's Introduction

Nested List Tool for Editor.js

Multi-leveled lists for the Editor.js.

Use Tab and Shift+Tab keys to create or remove sublist with a padding.

Installation

Install via NPM

Get the package

npm i --save @editorjs/nested-list

yarn add @editorjs/nested-list

Include module at your application

import NestedList from '@editorjs/nested-list';

Load from CDN

Load the script from jsDelivr CDN and connect to your page.

<script src="https://cdn.jsdelivr.net/npm/@editorjs/nested-list@latest"></script>

Usage

Add the NestedList Tool to the tools property of the Editor.js initial config.

import EditorJS from '@editorjs/editorjs';
import NestedList from '@editorjs/nested-list';

var editor = EditorJS({
  // ...
  tools: {
    ...
    list: {
      class: NestedList,
      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 a list: `ordered` or `unordered`
items	`Item[]`	the array of list's items

Object Item:

Field	Type	Description
content	`string`	item's string content
items	`Item[]`	the array of list's items

{
    "type" : "list",
    "data" : {
        "style" : "unordered",
        "items" : [
            {
              "content": "Apples",
              "items": [
                {
                  "content": "Red",
                  "items": []
                },
                {
                  "content": "Green",
                  "items": []
                },
              ]
            },
            {
              "content": "Bananas",
              "items": [
                {
                  "content": "Yellow",
                  "items": []
                },
              ]
            },
        ]
    }
},

Recommend Projects