Header Tool for CodeX Editor 2.0
Switch branches/tags
Nothing to show
Clone or download
Latest commit da319d4 Aug 28, 2018
Permalink
Failed to load latest commit information.
dist Improve Toolbar position Aug 27, 2018
src Improve Toolbar position Aug 27, 2018
.gitignore Header Tool for CodeX Editor 2.0 Jul 27, 2018
LICENSE Header Tool for CodeX Editor 2.0 Jul 27, 2018
README.md update constructor Aug 3, 2018
package-lock.json 2.0.5 Aug 28, 2018
package.json 2.0.5 Aug 28, 2018
webpack.config.js remove css Jul 27, 2018

README.md

Header Tool

Provides Headings Blocks for the CodeX Editor.

Installation

Install via NPM

Get the package

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

Include module at your application

const Header = require('codex.editor.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/codex.editor.header@2.0.4

Then require this script on page with CodeX Editor.

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

Usage

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

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.

var editor = CodexEditor({
  ...
  
  tools: {
    ...
    header: {
      class: Header,
      shortcut: 'CMD+SHIFT+H',
    },
  },
  
  ...
});

Config Params

Field Type Description
placeholder string header's placeholder string
var editor = CodexEditor({
  ...
  
  tools: {
    ...
    header: {
      class: Header,
      config: {
        placeholder: 'Enter a header'
      }
    }
  }
  
  ...
});

Tool's settings

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
{
    "type" : "header",
    "data" : {
        "text" : "Why Telegram is the best messenger",
        "level" : 2
    }
}