Editor Plugin Collab Edit

Collab Edit plugin for @atlaskit/editor-core

Note: This component is designed for internal Atlassian development. External contributors will be able to use this component but will not be able to submit issues.

Overview

The Collab Edit plugin provides real-time collaborative editing capabilities for the Atlassian Editor. It integrates with collaboration providers to manage document synchronization, track participant changes, and handle conflict resolution during concurrent editing sessions.

Key features

• Real-time synchronization - Synchronize document changes across multiple concurrent editors
• Participant tracking - Monitor active participants and their presence in the document
• Step management - Handle document steps, transformations, and step validation
• Conflict resolution - Manage and track reconnection conflicts during collaborative sessions
• Organic change tracking - Monitor local and remote organic changes to the document
• Inline comments - Support for collaborative inline commenting with marks
• Analytics integration - Track collaboration metrics and error reporting

Install

• Install - yarn add @atlaskit/editor-plugin-collab-edit
• npm - @atlaskit/editor-plugin-collab-edit
• Source - Bitbucket
• Bundle - unpkg.com

Usage

Internal use only

@atlaskit/editor-plugin-collab-edit is intended for internal use by the @atlaskit/editor-core and as a plugin dependency of the Editor within your product.

Direct use of this component is not supported.

Please see Atlaskit - Editor plugin collab edit for documentation and examples for this package.

Support

For internal Atlassian, visit the slack channel #help-editor for support or visit go/editor-help to submit a bug.

License

Please see Atlassian Frontend - License for more licensing information.