@groupher/editor-header

2.3.2 • Public • Published

Header Tool

Version of EditorJS that the plugin is compatible with

Provides Headings Blocks for the Editor.js.

Installation

Install via NPM

Get the package

npm i --save-dev @editorjs/header

Include module at your application

const Header = require('@editorjs/header');

Download to your project's source dir

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

Load from CDN

You can load specific version of package from jsDelivr CDN.

https://cdn.jsdelivr.net/npm/@editorjs/header@latest

Then require this script on page with Editor.js.

<script src="..."></script>

Usage

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

var 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

Field Type Description
placeholder string header's placeholder string
var editor = EditorJS({
  ...

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

  ...
});

Tool's settings

An image showing the header block tool

You can select one of three 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
  }
}

Versions

Current Tags

VersionDownloads (Last 7 Days)Tag
2.3.249latest

Version History

VersionDownloads (Last 7 Days)Published
2.3.249
2.3.10
2.3.00

Package Sidebar

Install

npm i @groupher/editor-header

Weekly Downloads

49

Version

2.3.2

License

MIT

Unpacked Size

188 kB

Total Files

5

Last publish

Collaborators

  • mydearxym