@kalebu2468/editor-lessons
v0.0.12
Published
Lesson Tool for Editor.js
Downloads
59
Maintainers
Readme
Lesson Tool
Provides Lesson Blocks for the Editor.js.
Installation
Get the package
yarn add @kalebu2468/editor-lessons
Include module at your application
import Lessons from "@kalebu2468/editor-lessons";
Usage
Add a new Tool to the tools
property of the Editor.js initial config.
var editor = EditorJS({
...
tools: {
...
lessons: Lessons,
},
...
});
Shortcut
You can insert this Block by a useful shortcut. Set it up with the tools[].shortcut
property of the Editor's initial config.
var editor = EditorJS({
...
tools: {
...
lessons: {
class: Lessons,
},
},
...
});
Config Params
All properties are optional.
| Field | Type | Description |
| ------------ | ---------- | --------------------------- |
| placeholder | string
| lesson's placeholder string |
| levels | number[]
| enabled lesson levels |
| defaultLevel | number
| default lesson level |
var editor = EditorJS({
...
tools: {
...
lessons: {
class: Lessons,
config: {
placeholder: 'Enter a lesson',
levels: [2, 3, 4],
defaultLevel: 3
}
}
}
...
});
Tool's settings
You can select one of six levels for heading.
Output data
| Field | Type | Description |
| ----- | -------- | --------------- |
| text | string
| lesson's text |
| level | number
| level of lesson |
{
"type": "lessons",
"data": {
"text": "Why Telegram is the best messenger",
"level": 2
}
}