CollaborationSettingsModel

9 Jul 20261 minute to read

Interface for a class CollaborationSettings

Properties

adapter CollaborationAdapter

Specifies the collaboration adapter used to integrate the editor
with a collaborative data model/runtime such as Yjs.
The adapter provides the shared document/root instance and
engine-specific runtime objects required for real-time collaboration.

enableAwareness boolean

Specifies whether to enable awareness for cursor tracking across users.
When enabled, users can see each other’s cursor positions.

provider any

Specifies the list of provider instances for syncing changes across clients.
Can include WebsocketProvider, HocusPocusProvider, or other multiplayer providers.

versionHistory VersionHistorySettingsModel

Configures the version history feature.
When provided with a valid storage backend, automatic snapshotting is enabled
and the version management API becomes available via getVersionHistory().