editor.js/docs/installation.md

Installation Guide

There are few steps to run CodeX Editor 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 CodeX Editor itself. It is a minified script with minimal available

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 at 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/codex.editor@2.0.0

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 via the same ways as an Editor (Node.js, CDN, local file).

Check CodeX Editor's community to see Tools examples.

Example: use Header from CDN

<script src="https://cdn.jsdelivr.net/npm/codex.editor.header@2.0.4/dist/bundle.js"></script>

Create Editor instance

Create an instance of CodeX Editor and pass Configuration Object. Minimal params is a holderId, tools list and initialBlock marker.

<div id="codex-editor"></div>

You can create a simple Editor only with a default Paragraph Tool by passing a string with element's Id (wrapper for Editor) as a configuration param or use default codex-editor.

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: {}
});

Ready callback

CodeX Editor needs a bit time to initialize. It is an asynchronous action so it won't block execution of your main script.

If you need to know when editor instance is ready you can use one of following ways:

Pass onReady property to the configuration object.

It must be a function:

var editor = new CodexEditor({
   // Other configuration properties

   /**
    * onReady callback
    */
   onReady: () => {console.log('CodeX Editor is ready to work!')}
});

Use isReady promise.

After you create new CodexEditor object it contains isReady property. It is a Promise object resolved when editor is ready to work and rejected otherwise. If there is an error during initialization isReady promise will be rejected with error message.

var editor = new CodexEditor();

editor.isReady
  .then(() => {
    /** Do anything you need after editor initialization */
  })
  .catch((reason) => {
    console.log(`CodeX Editor initialization failed because of ${reason}`)
  });

You can use async/await to keep your code looking synchronous:

var editor = new CodexEditor();

try {
  await editor.isReady;
  /** Do anything you need after editor initialization */
} catch (reason) {
  console.log(`CodeX Editor initialization failed because of ${reason}`)
}

Saving Data

Call editor.saver.save() and handle returned Promise with saved data.

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

Features

Also CodeX Editor provides useful methods to work with Editor's state.

var editor = new CodexEditor({
   // Other configuration properties

   /**
    * onReady callback
    */
   onReady: () => {console.log('CodeX Editor is ready to work!')},
   
   /**
    * onChange callback
    */
   onChange: () => {console.log('Now I know that Editor\'s content changed!')}
});

Example

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