1.0.2 • Published 2 years ago
@juratbek/editorjs-header v1.0.2
Heading Tool For EditorJs
Provides Headings Blocks for the Editor.js.
Installation
Installation
npm
npm i --save @juratbek/editorjs-headeryarn
npm i --save @juratbek/editorjs-headerUsage
Add the Code tool to the tools property of the Editor.js initial config.
import EditorJs from "@editorjs/editorjs";
import Header from "@juratbek/editorjs-header";
const editor = EditorJs({
// ...
tools: {
header: Header,
},
});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: {
...
header: {
class: Header,
shortcut: 'CMD+SHIFT+H',
},
},
...
});Config Params
All properties are optional.
| Field | Type | Description |
|---|---|---|
| placeholder | string | header's placeholder string |
| levels | number[] | enabled heading levels |
| defaultLevel | number | default heading level |
var editor = EditorJS({
...
tools: {
...
header: {
class: Header,
config: {
placeholder: 'Enter a header',
levels: [2, 3, 4],
defaultLevel: 3
}
}
}
...
});You can select one of six levels for heading.
Output data
| Field | Type | Description |
|---|---|---|
| text | string | header's text |
| level | number | level of header: 1 for H1, 2 for H2 ... 6 for H6 |
{
"type": "header",
"data": {
"text": "Why Telegram is the best messenger",
"level": 2
}
}