codex.editor

v2.10.0

Published

2 years ago

CodeX Editor. Native JS, based on API and Open Source

Downloads

0High
0Medium
0Low

codex-team

Project has been renamed

Since version 2.10 CodeX Editor has been renamed to Editor.js. Please, use this package.

Version 2.0-beta is here!

We are glad to introduce the next version of CodeX Editor. Totally new core, structure and plugins — that was an impressive adventure 🤓.

Welcome to testing stage. Please, join a public Telegram-chat where you always find a support.

Browsers support

| IE / Edge | Firefox | Chrome | Safari | iOS Safari | Opera | | --------- | --------- | --------- | --------- | --------- | --------- | | Edge 12+ | Firefox 18+ | Chrome 49+ | Safari 10+ | Safari 10+ | Opera 36+

2.7-2.9 changelog

New — Toolbox now have beautiful helpers with Tool names and shortcuts
Improvements — Prevent navigating back on Firefox when Block is removing by backspace
New — Blocks selected with Rectangle Selection can be also removed, copied or cut
New — Migrate from postcss-cssnext to postcss-preset-env and disable postcss-custom-properties which conflicts with postcss-preset-env
New RectangeSelection — Ability to select Block or several Blocks with mouse

2.2—2.7 changelog

New Sanitize API — Sanitize Config of Block Tools now automatically extends by tags of Inline Tools that is enabled by current Tool by inlineToolbar option. You don't need more to specify a, b, mark, code manually. This feature will be added to fields that supports inline markup.
New Block Selection — Ability to select Block by CMD+A, and the whole Editor by double CMD+A. After that, you can copy (CMD+C), remove (Backspace) or clear (Enter) selected Blocks.
New Styles API — Added button class for stylization of any buttons provided by Tools with one unified style.
New Notifier API — methods for showing user notifications: on success, errors, warnings, etc.
New Block Tool — Table constructor 💪
New If one of the Tools is unavailable on Editor initialization, its Blocks will be rendered with Dummy Block, describing that user can not edit content of this Block. Dummy Blocks can be moved, removed and saved as normal Blocks. So saved data won't be lost if one of the Tools is failed
New Public TS-types are presented.
Changes Tools API — options irreplaceable and contentless was removed.
Changes Tools API — Paste API: tags, patterns and mime-types now should be specified by Tool's pasteConfig static property. Custom Paste Event should be handled by onPaste(event) that should not be static from now.
Changes Tools API — options displayInToolbox and toolboxIcon was removed. Use toolbox instead, that should return object with icon and title field, or false if Tool should not be placed at the Toolbox. Also, there are a way to override toolbox {icon, title} settings provided by Tool with you own settings at the Initial Config.
Improvements — All Projects code now on TypeScript
Improvements — NPM package size decreased from 1300kb to 422kb
Improvements — Bundle size decreased from 438kb to 252kb
Improvements — Inline Toolbar: when you add a Link to the selected fragment, Editor will highlight this fragment even when Caret is placed into the URL-input.
Improvements — Block Settings won't be shown near empty Blocks of initialType by default. You should click on them instead.
Improvements — onChange-callback now will be fired even with children attributes changing.
Improvements — HTMLJantior package was updated due to found vulnerability
Improvements — Logging improved: now all Editor's logs will be preceded by beautiful label with current Editor version.
Improvements — Internal isEmpty checking was improved for Blocks with many children nodes (200 and more)
Improvements — Paste improvements: tags that can be substituted by Tool now will matched even on deep-level of pasted DOM three.
Improvements — There is no more «unavailable» sound on copying Block by CMD+C on macOS
Improvements — Dozens of bugfixes and small improvements

See a whole Changelog

Documentation

While we develop the new Documentation Site with all stuff, you can check some available docs at the docs/ dir.

Sorry if we missed something. You can join a Telegram-chat and ask a question.

So how to use CodeX Editor

Basics

CodeX Editor 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 the simple API for creation 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.

Shortcuts

We really appreciate shortcuts. So there are few presets.

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

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

Installation Guide

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

Load Editor's core

Firstly you need to get CodeX Editor 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

Node.js

Install the package via NPM or Yarn

npm i codex.editor --save-dev

Include module in your application

const CodexEditor = require('codex.editor');

Use from CDN

You can load specific version of package from jsDelivr CDN.

https://cdn.jsdelivr.net/npm/[email protected]

Then require this script.

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

Save sources to project

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

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

Load Tools

Each Block at the CodeX Editor represented by Tools. There are simple external scripts with 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 CodeX Editor's community to see more ready-to-use Tools.

Example: use Header from CDN

<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/bundle.js"></script>

Create Editor instance

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

<div id="codex-editor"></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 codex-editor id for wrapper.

var editor = new CodexEditor(); /** Zero-configuration */

// equals

var editor = new CodexEditor('codex-editor');

Or pass a whole settings object.

var editor = new CodexEditor({
    /**
     * Create a holder for the Editor and pass its ID
     */
    holderId : 'codex-editor',

    /**
     * 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 editor.saver.save() and handle returned Promise with saved data.

editor.saver.save()
  .then((savedData) => {
    console.log(savedData);
  });

Example

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

Credits and references

We use HTMLJanitor module in our Sanitizer module.