Header Tool

Provides Headings Blocks for the CodeX Editor.

Installation

$3

Get the package

``shell
npm i --save-dev codex.editor.header
`

Include module at your application

`javascript
const Header = require('codex.editor.header');
`

$3

1. Upload folder dist from repository
2. Add dist/bundle.js file to your page.

$3

https://cdn.jsdelivr.net/npm/codex.editor.header@2.0.4

Then require this script on page with CodeX Editor.

`html

`

Usage

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

`javascript
var editor = CodexEditor({
...

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.

`javascript
var editor = CodexEditor({
...

tools: {
...
header: {
class: Header,
shortcut: 'CMD+SHIFT+H',
},
},

...
});
`

Config Params

| Field | Type | Description |
| ----------- | -------- | --------------------------- |
| placeholder | string | header's placeholder string |

`javascript
var editor = CodexEditor({
...

tools: {
...
header: {
class: Header,
config: {
placeholder: 'Enter a header'
}
}
}

...
});
`

Tool's settings

![](https://capella.pics/5ef43c5b-441f-48bd-9b53-854f57f8161b.jpg)

You can select one of three levels for heading.

Output data

| Field | Type | Description |
| ------ | -------- | --------------------------------------------- |
| text | string | header's text |
| level | number | level of header: 2 for H2, 3 for H3, 4 for H4 |


`json
{
"type" : "header",
"data" : {
"text" : "Why Telegram is the best messenger",
"level" : 2
}
}
``