Network Powering Makers

    TypeScript icon, indicating that this package has built-in type declarations

    2.15.8 • Public • Published

    Backers on Open Collective Sponsors on Open Collective Join the chat at

    IE / EdgeIE / Edge FirefoxFirefox ChromeChrome SafariSafari iOS SafariiOS Safari OperaOpera
    Edge 12+ Firefox 18+ Chrome 49+ Safari 10+ Safari 10+ Opera 36+

    If you like a project 💗💗💗

    If you like Editor.js you can support project improvements and development of new features with a donation to our collective.


    👉 Bitcoin: 3DCCemgtE6GrzehVpU6Sa2RJHFUUh8iT9q


    Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]


    Thank you to all our backers! 🙏 [Become a backer]


    This project exists thanks to all the people who contribute.

    We are really welcome new contributors. If you want to make some code with us, please take a look at the Good First Tasks. You can write to us on or via special Telegram chat, or any other way.


    Please, visit to view all documentation articles.

    You can join a Gitter-channel or Telegram-chat and ask a question.


    See a whole Changelog

    So how to use Editor.js


    Editor.js is a Block-Styled editor. Blocks are structural units, of which the Entry is composed. For example, Paragraph, Heading, Image, Video, List are Blocks. Each Block is represented by Plugin. We have many ready-to-use Plugins and a simple API for creating new ones.

    So how to use the Editor after Installation.

    • Create new Blocks by Enter or with the Plus Button
    • Press TAB or click on the Plus Button to view the Toolbox
    • Press TAB again to leaf Toolbox and select a Block you need. Then press Enter.

    • Select text fragment and apply a style or insert a link from the Inline Toolbar

    • Use «three-dots» button on the right to open Block Settings. From here, you can move and delete a Block or apply Tool's settings, if it provided. For example, set a Heading level or List style.


    We really appreciate shortcuts. So there are few presets.

    Shortcut Action Restrictions
    TAB Show/leaf a Toolbox. On empty block
    SHIFT+TAB Leaf back a Toolbox. While Toolbox is opened
    ENTER Create a Block While Toolbox is opened and some Tool is selected
    CMD+B Bold style On selection
    CMD+I Italic style On selection
    CMD+K Insert a link On selection

    Also we support shortcuts on the all type of Tools. Specify a shortcut with the Tools configuration. For example:

    var editor = new EditorJS({
      tools: {
        header: {
          class: Header,
          shortcut: 'CMD+SHIFT+H'
        list: {
          class: List,
          shortcut: 'CMD+SHIFT+L'

    Installation Guide

    There are few steps to run Editor.js on your site.

    1. Load Editor's core
    2. Load Tools
    3. Initialize Editor's instance

    Load Editor's core

    Firstly you need to get Editor.js itself. It is a minified script with Editor's core and some default must-have tools.

    Choose the most usable method of getting Editor for you.

    • Node package
    • Source from CDN
    • Local file from project


    Install the package via NPM or Yarn

    npm i @editorjs/editorjs

    Include module in your application

    const EditorJS = require('@editorjs/editorjs');

    Use from CDN

    You can load specific version of package from jsDelivr CDN.

    Then require this script.

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

    Save sources to project

    Copy editor.js file to your project and load it.

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

    Load Tools

    Each Block at the Editor.js is represented by Tools. There are simple external scripts with their own logic. Probably you want to use several Block Tools that should be connected.

    For example check out our Header Tool that represents heading blocks.

    You can install Header Tool by the same way as the Editor (Node.js, CDN, local file).

    Check Editor.js's community to see more ready-to-use Tools.

    Example: use Header from CDN

    <script src=""></script>

    Create Editor instance

    Create an instance of Editor.js and pass Configuration Object with holderId and tools list.

    <div id="editorjs"></div>

    You can create a simple Editor with only default Paragraph Tool by passing a string with element's Id (wrapper for Editor) as a configuration param. Or use the default editorjs id for wrapper.

    var editor = new EditorJS(); /** Zero-configuration */
    // equals
    var editor = new EditorJS('editorjs');

    Or pass a whole settings object.

    var editor = new EditorJS({
         * Create a holder for the Editor and pass its ID
        holder : 'editorjs',
         * Available Tools list.
         * Pass Tool's class or Settings object for each Tool you want to use
        tools: {
            header: {
              class: Header,
              inlineToolbar : true
            // ...
         * Previously saved data that should be rendered
        data: {}

    Saving Data

    Call and handle returned Promise with saved data.
      .then((savedData) => {


    Take a look at the example.html to view more detailed examples.

    Credits and references

    About team

    We are CodeX and we build products for developers and makers.

    Follow us on Twitter:

    Feel free to contact:


    npm i @groupher/editor

    DownloadsWeekly Downloads






    Unpacked Size

    367 kB

    Total Files


    Last publish


    • mydearxym