@editorjs/checklist

1.6.0 • Public • Published

Checklist Tool for Editor.js

This Tool for the Editor.js allows you to add checklists to your texts.

Installation

Get the package

yarn add @editorjs/checklist

Include module at your application

import Checklist from '@editorjs/checklist'

Optionally, you can load this tool from CDN JsDelivr CDN

Usage

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

var editor = EditorJS({
  ...

  tools: {
    ...
    checklist: {
      class: Checklist,
      inlineToolbar: true,
    },
  }

  ...
});

Config Params

This Tool has no config params

Output data

Field Type Description
items object[] array of checklist's items
{
    "type" : "checklist",
    "data" : {
        "items" : [
            {
              "text" : "This is a block-styled editor",
              "checked" : true
            },
            {
              "text" : "Clean output data",
              "checked" : false
            },
            {
              "text" : "Simple and powerful API",
              "checked" : true
            }
        ]
    }
}

Package Sidebar

Install

npm i @editorjs/checklist

Weekly Downloads

17,697

Version

1.6.0

License

MIT

Unpacked Size

21 kB

Total Files

7

Last publish

Collaborators

  • codex-team