codoxinstance has been created, you should initialize the
codoxinstance with app specific configurations. The general structure of the
configJSON is as follows:
The static string value
'froala', 'quill', or 'tinymce'
A unique identifier for the document. In a content management service, this could for example be the resource identifier for the document.
The uniqueness of the identifier is essential to avoid collisions between one co-editing session and another. In particular, if you are running multiple subdomains for user subscriptions, make sure the docId is "namespaced" and unique across all the subdomains .
This user field allows you to attach app specific meta-data to the user.
The value of the
avatarfield is a link to an image resource. If
avatarhas a value specified, it will override the default solid background avatar implementation.
The value of
colorcan be any valid css color property value (e.g.,
'rgb(0, 0, 255)') .
A reference to an editor instance for which the co-editing session should start in. For Froala and Quill integrations, assign
editorthe reference to the editor object. For TinyMCE, the plugin will pass in the editor object reference automatically.
codoxinstance is bound to a single
editorinstance. If the editor is destroyed and recreated as part of some UI framework lifecycle events, then a new
codoxobject should be created with the new
trueto start co-editing immediately on call to
init(config). Set to
falseto initialize but delay the start to co-editing (see the
This is an optional configuration parameter that determines the position of the avatars relative to the editor window.
The avatars are placed horizontally by the top-right corner of the editor window by default.
verticalboth default to
trueto show avatars for online users. Set to
falseto hide the avatars.
true, to display cursor positions and selections for remote co-editing users. Set to
falseto hide cursor positions and selections.
trueto always show remote users' caret with username.
true, to display pointer positions and click events of remote co-editing users. Set
falseto hide pointers.
This is an optional parameter that controls the rendering of remote pointers. Static string values: 'arrow', 'hand', 'pointer', 'pointerSolid'.
The name of the user joining the co-editing session. For a content management service, this should be set for each logged-in user based on their credentials. This name will be displayed during real-time co-editing sessions.
usernameis deprecated and will be removed in the next major release (v2). Please use the
Please refer to individual editor integration instructions on how to specify the values of these parameters.