readme.md

SharedCodeEditor

This is a web based code editor library that wraps around the Monaco Editor to support OTs and multi-user cursors.

Available Scripts

Before running any scripts, install Node and Yarn on your system.

To install all dependencies, run:

$ yarn install

To serve the example web page for development, run:

$ yarn start

Check out http://localhost:4000 on your web browser for the example page.

To build the library, run:

$ yarn build

How to use

Basic usage

Check out example web page for development environment to see how to use the library with an interactive example web page.

The easiest way to use SharedCodeEditor is to simply load the bundle script under ./lib in the distribution. For example:

<script src="lib/shared-code-editor.bundle.js"></script>

Having this script tag, a shared code editor instance can be created like this:

var options = {};
var editor = monaco.editor.create(document.getElementById('editor'), options);
var sceditor = new SharedCodeEditor(editor);

If you want to use SharedCodeEditor in CommonJS environment, you can require the SharedCodeEditor class from ./lib/shared-code-editor.js. For example:

var SharedCodeEditor = require('shared-code-editor/lib/shared-code-editor.js').default;

or with import syntax,

import Elixercise from 'shared-code-editor/lib/shared-code-editor.js';

For a working example, run $ yarn start script and check out the example web page. This shows the ./index.html file rendered on the browser with all dependencies ready.

Options

Following options are available on SharedCodeEditor.

getBlockTag

This option allows you to show a DOM element next to the user selection on the editor. In other words, if the user selects multiple characters on the editor with the cursor, a DOM element will show up next to the cursor.

To use this feature, you need to pass a function that returns the DOM element that you want to show next to the cursor.

Example

var options = {
  getBlockTag: () => {
    const el = document.createElement('div');
    el.innerHTML = 'Go to Google';
    el.className = 'editor-block-tag';
    el.style.cssText = `cursor: pointer;`;
    el.onclick = () => {
      window.location.href = 'https://www.google.com';
    };
    return el;
  },
};