# @editorjs/checklist

> Checklist Tool for Editor.js

Latest version **1.6.0** (published 2023-11-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install @editorjs/checklist
pnpm add @editorjs/checklist
yarn add @editorjs/checklist
bun add @editorjs/checklist
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.6.0 |
| Published | 2023-11-10 |
| First published | 2019-03-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 20.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 68 |
| Author | CodeX |
| Maintainers | codex-team |
| Keywords | codex editor, checklist, editor.js, editorjs |

## Links

- npm: https://www.npmjs.com/package/@editorjs/checklist
- Repository: https://github.com/editor-js/checklist
- npm.io page: https://npm.io/package/@editorjs/checklist

## Dependencies (1)

- [@codexteam/icons](https://npm.io/package/@codexteam/icons.md) ^0.3.0

## Alternatives

- [ext-list](https://npm.io/package/ext-list.md) — 6.3M weekly downloads
- [@lexical/selection](https://npm.io/package/@lexical/selection.md) — 3.8M weekly downloads
- [@lexical/text](https://npm.io/package/@lexical/text.md) — 3.6M weekly downloads
- [@lexical/clipboard](https://npm.io/package/@lexical/clipboard.md) — 3.0M weekly downloads
- [@tiptap/extension-mention](https://npm.io/package/@tiptap/extension-mention.md) — 3.0M weekly downloads

## Recent versions

- 1.6.0 (latest) — 2023-11-10
- 1.5.0 — 2023-04-15
- 1.4.0 — 2022-11-29
- 1.3.0 — 2020-11-05
- 1.2.0 — 2020-09-29
- 1.1.0 — 2019-03-02

## README

![](https://badgen.net/badge/Editor.js/v2.0/blue)

# Checklist Tool for Editor.js

This Tool for the [Editor.js](https://editorjs.io) allows you to add  checklists to your texts.

![](assets/68747470733a2f2f636170656c6c612e706963732f66303939646439622d313332312d343766362d623965312d3937666331656634306236612e6a7067.jpeg)

## Installation

Get the package

```shell
yarn add @editorjs/checklist
```

Include module at your application

```javascript
import Checklist from '@editorjs/checklist'
```

Optionally, you can load this tool from CDN [JsDelivr CDN](https://cdn.jsdelivr.net/npm/@editorjs/checklist@latest)

## Usage

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

```javascript
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             |


```json
{
    "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
            }
        ]
    }
}
```

---
_Source: https://npm.io/package/@editorjs/checklist · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._