codox instance has been created, you should initialize the
codox instance with app specific configurations. The general structure of the
config JSON 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.
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.
The 'user' object will be emitted on 'users_update' event.
A reference to an editor instance for which the co-editing session should start in. For Froala and Quill integrations, assign
editor the reference to the editor object. For TinyMCE, the plugin will pass in the editor object reference automatically.
true to start co-editing immediately on call to
init(config). Set to
false to initialize but delay the start to co-editing (see the
codox.start() client API).
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
true to show avatars for online users. Set to
false to hide the avatars.
true, to display cursor positions and selections for remote co-editing users. Set to
false to hide cursor positions and selections.
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.
Please refer to individual editor integration instructions on how to specify the values of these parameters.