Package Exports

@coolbytes/editorjs-code
@coolbytes/editorjs-code/dist/bundle.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@coolbytes/editorjs-code) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Code block tool for Editor.js

This Editor.js block tool allows you to add code elements. It supports multiple languages for syntax highlighting (requires third-party libraries).

Preview

Block Tool

code

Block Settings

settings

Installation

Using npm

npm install @coolbytes/editorjs-code

Using yarn

yarn add @coolbytes/editorjs-code

Usage

Include it in the tools property of Editor.js config:

const editor = new EditorJS({
  tools: {
    code: Code
  }
});

Config Params

Field	Type	Optional	Default	Description
languages	`string[]`	`Yes`	see list below	All supported languages
defaultLanguage	`string`	`Yes`	`plaintext`	Preferred default language

Supported Languages

[
  'apache', 'applescript', 'bash', 'basic', 'csharp', 'c', 'cpp', 'cobol', 'css', 'coffeescript', 'cypher',
  'dart', 'dockerfile', 'dos', 'erlang', 'fortran', 'golang', 'gradle', 'graphql', 'groovy', 'gsql', 'html', 'xml',
  'haskell', 'json', 'java', 'javascript', 'julia', 'kotlin', 'lisp', 'lua', 'markdown', 'matlab', 'nginx',
  'objectivec', 'php', 'perl', 'plaintext', 'postgresql', 'powershell', 'puppet', 'python', 'ruby', 'rust', 'scss',
  'sql', 'scala', 'shell', 'swift', 'terraform', 'tsql', 'typescript', 'vbnet', 'vba', 'vbscript', 'vim', 'yaml', 'zephir'
]

Custom Configuration

const editor = EditorJS({
  tools: {
    code: {
      class: Code,
      config: {
        languages: ['plaintext', 'bash', 'sql'],
        defaultLanguage: 'plaintext'
      }
    }
  }
});

Output data

Field	Type	Description
code	`string`	Code content
language	`string`	Code language

Example:

{
  "time": 1715969561758,
  "blocks": [
    {
      "id": "_K5QcJHHuK",
      "type": "code",
      "data": {
        "code": "This is some code",
        "language": "bash"
      }
    }
  ],
  "version": "2.29.1"
}

Known Issues

While Pasting after a CMD+A selection, only the first character is replaced (Firefox, but works on Safari).
- Workaround is to remove the text after selection and then paste.
Extra new line break added for every Enter key on Safari browser.
There is no syntax highlighting for code. This is done to avoid any impact to the actual code data (Adding syntax highlighting can impact inner HTML, which will directly affect saved data).
Terminal buttons are non-functional. These are intentionally left to avoid making the package too complex. These can be anyway be added at the render time.