CodeMirror

Enable real-time co-editing for CodeMirror 5

Overview

Add the Codox JavaScript library and css files:

<script src="https://cdn1.codox.io/lib/2.x/api/wave.client.js" type="text/javascript"></script>

<link href="https://cdn1.codox.io/lib/2.x/css/wave.client.css" rel="stylesheet" />

JavaScript code

Add the following JavaScript block to your application to enable real-time co-editing for CodeMirror. Replace the apiKey field with your own, which you can get here.

const editor = CodeMirror.fromTextArea(document.getElementById('editor'), {});

let codox = new Codox();
//Codox configuration

let config = {
  docId: 'mydoc',
  app: 'codemirror',
  editor: editor,
  apiKey: '',
  user: { name: 'Steve' },
};

//Start!
codox.start(config);

The co-editing session will start inside the CodeMirror editor instance specified in the editorattribute.

Before invoking codox.init() the CodeMirror editor should be fully initialized. In the example code, we ensure that CodeMirror is initialized first by adding an initialized event hook to CodeMirror constructor.

The values for docIdandusername should come from your document management service. Codox expects docIdto be globally unique across your service.

Multiple Instances

Every co-editing session should have its distinct codox object. That means if you are running multiple instances of CodeMirror editor on the same page or with in the same application, there should be multiple instances of codox, one for each CodeMirror editor instance or document fragment (note: each document fragment should be uniquely identifiable).

Parameters

The config parameter is a JSON object with the following key-value pairs:

Summary

Key		Value
`app`	`(required)`	`string`
`docId`	`(required)`	`string`
`user`	`(required)`	`object`
`apiKey`	`(required)`	`string`
`editor`	`(required)`	`CodeMirror`
`autoStart`	`(optional)`	`boolean`

Additional configration paramaters can be found here

Description

`app`

string

The static string value 'codemirror'

`docId`

string

A unique identifier for the document. In a content management service, this could for example be the resource identifier for the document.

`user`

object

A user meta-data object.

Key		Value
`name`	`(optional)`	`string`
`email`	`(optional)`	`string`
`avatar`	`(optional)`	`string`
`id`	`(optional)`	`string`

For a content management service, this field should be set for each logged-in user based on their credentials. The value of user.name will be used to render the default text-based initials avatar. To create an image-based avatar, set user.avatar to the path of the image resource.

`apiKey`

string

The API key for the CodeMirror integration. You can obtain a key from your account.

`editor`

CodeMirror

A reference to a CodeMirror editor instance, in which the co-editing session should be bootstrapped.

`autoStart (optional)`

boolean

Set to true to start the co-editing session automatically on init(config). Set to false to initialize but delay start the co-editing (see the start() client API). Default setting is true.