Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/editor-js/checklist
Checklist Tool for Editor.js
https://github.com/editor-js/checklist
Last synced: about 2 months ago
JSON representation
Checklist Tool for Editor.js
- Host: GitHub
- URL: https://github.com/editor-js/checklist
- Owner: editor-js
- License: mit
- Created: 2019-01-02T10:09:39.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-19T20:14:04.000Z (7 months ago)
- Last Synced: 2024-07-07T08:02:31.997Z (6 months ago)
- Language: JavaScript
- Homepage:
- Size: 480 KB
- Stars: 52
- Watchers: 2
- Forks: 35
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-editorjs - @editorjs/checklist
README
# Checklist Tool for Editor.js
> [!IMPORTANT]
> This repository is deprecated and is no longer supported.
Take a look at a new repository [List tool](https://github.com/editor-js/list) with more functionality and compatibility with old data.
## 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
}
]
}
}
```