TextArea
Enable real-time co-editing for TextArea
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">

Add the following JavaScript block to your application to enable real-time co-editing for TextArea. Replace the
apiKey
field with your own, which you can get here.1
const codox = new Codox();
2
3
//Codox configuration
4
const config = {
5
"docId" : "mydoc",
6
"app" : "text",
7
"editor" : document.getElementById('editor'),
8
"apiKey" : "0af63831-3c9d-4534-b158-134986354dd9",
9
"user" : {"name" : "Steve"}
10
};
11
12
//start!
13
codox.start(config);
The co-editing session will start inside the
textarea
element specified in the editor
attribute. The values for
docId
andusername
should come from your document management service. Codox expects docId
to be globally unique across your service. Every co-editing session should have its distinct
codox
object. That means if you are running multiple textarea
elements on the same page or with in the same application, there should be multiple instances of codox,
one for each textarea.
The
config
parameter is a JSON object with the following key-value pairs:Key | | Value |
app | (required) | string |
docId | (required) | string |
user | (required) | object |
apiKey | (required) | string |
editor | (required) | textarea Element |
autoStart | (optional) | boolean |
string
The static string value
'text'
string
A unique identifier for the document. In a content management service, this could for example be the resource identifier for the document.
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. string
Element
DOM element reference to a
textarea
, in which the co-editing session should be bootstrapped. 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
. Last modified 5d ago