CKEditor Ecosystem Documentation
Search
⚠️ WarningNightly documentation ahead. Switch to the stable editor documentation.
Home/CKEditor 5/API
Interface

RealTimeCollaborationConfig (real-time-collaboration)

@ckeditor/ckeditor5-real-time-collaboration/src/realtimecollaborativeediting

interface

The configuration of the real-time collaboration features.

ClassicEditor
	.create( {
		collaboration: ... // Collaboration features configuration.
	} )
	.then( ... )
	.catch( ... );

See all editor options.

Filtering

Properties

  • channelId : String

    The channel ID is used to identify a data storage for collaboration features that a given editor or context should connect to. If you are using multiple editors, each of them should use a different channel ID to connect to a specific document. Additionally, if you would like to use collaboration features outside of an editor, you should also specify a unique channel ID for the Context.

    The channel ID is frequently used as a parameter or data property in the comments API. If you are preparing a custom integration using the comments API, you can use the channel ID to recognize whether the comment was added to an editor instance or to a context.

    Note that it is not always mandatory to provide the channelId configuration. If your integration does not use the Context and supports comments only inside the editor, you do not need to handle this property.

    ClassicEditor
	.create( {
		collaboration: {
			channelId: 'your-channel-id'
		}
	} )
	.then( ... )
	.catch( ... );