CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Interface

RealTimeCollaborationConfig (collaboration-core)

@ckeditor/ckeditor5-collaboration-core/src/config

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 | undefined

    The channel ID is a unique ID that identifies the data loaded in the editor instance or used by the context instance.

    If specified for the editor, it is the document ID.

    If you are using multiple editors instances at the same time, each of them should use a different channel ID to connect to a specific document.

    If specified for context, it is the ID for all the data related to context instance. This ID will be used for data that is not related to an editor instance, for example comments outside the editor.

    In the case of context, the ID can be an ID of a subpage or a form, or a different entity accordingly to your application.

    The channel ID can be used to recognize entity to which piece of data belongs in integrations that use Context and context plugins. For example, 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 (and which one) or to the context.

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