Days
Hours
Minutes
Seconds
x
Skip to content
Froala Documentation

Collaborative Plugin

Plugins are fully functional during your trial once you've added your trial key to the setup.

The Froala Collaboration Plugin brings enterprise-grade collaborative editing features directly to the Froala WYSIWYG Editor.

1. Real-time editing:

Live Syncing keeps every editor instance perfectly in sync in real time. When one user types, all other open instances update instantly — no refresh needed, no conflicts.

A Conflict-free Replicated Data Type (CRDT) engine resolves concurrent edits. Presence indicators show active cursors. WebSocket transport delivers sub-100ms latency.

2. Suggestion Mode Editing:

Writers or reviewers propose changes —  insertions, deletions, or rewrites — without directly altering the live document. Document owners accept or reject each suggestion individually or in bulk.

3. Comments:

Highlight any text and attach a threaded comment. Collaborators reply inline, resolve discussions, and @mention teammates — all anchored to the exact content being discussed.

With comments users can:

  • Threaded replies per comment anchor
  • @mention to notify specific users
  • Resolve / reopen discussion threads
  • Comments sidebar with full thread view
  • Filter: open, resolved, by author

4. Version Control:

View, compare, and restore previous document versions.

Users can

  • Browse: Scroll through timestamped snapshots with author attribution
  • Compare: Side-by-side diff of any two versions
  • Restore: One-click rollback to any prior state, no data loss
  • Audit: Full author + timestamp log for compliance requirements
Real-time collaboration and persistence require a backend server. The Collaborative backend ships in the wysiwyg-editor-node-sdk package and is split into four modules: a WebSocket relay for real-time peer sync, REST endpoints for comments and suggestions, a version history store, and an async content-save endpoint. All four can share a single HTTP server and a single SQLite file, and the required better-sqlite3 dependency installs automatically with the package. See Backend API Reference

Plugin API:

Plugin optionsPlugin methods
Plugin events

Add Plugin to your code:

Plugin name: collaborative

Plugin JS Script:
../js/plugins/collaborative.min.js

Or from CDN
https://cdn.jsdelivr.net/npm/froala-editor@latest/js/plugins/collaborative.min.js

Plugin CSS link: ../css/plugins/collaborative.min.css

Plugin CSS link https://cdn.jsdelivr.net/npm/froala-editor@latest/css/plugins/collaborative.min.css

 

Ready to dive in? Explore our plans