@veltdev/ckeditor-crdt-react
v1.0.1
Published
React component and hook for Velt CKEditor CRDT collaboration
Downloads
244
Readme
Velt CKEditor CRDT React Library
With Velt CKEditor CRDT React Library, you can add powerful multiplayer editing and state synchronization features to any React application using CKEditor 5. It wraps the framework-agnostic @veltdev/ckeditor-crdt core with React-native lifecycle handling.
The library provides React-first realtime primitives:
- Drop-in
<CKEditorCrdtEditor>component built on the official@ckeditor/ckeditor5-reactintegration useCollaborationhook for apps that already own a CKEditor instance- Fully-managed on a scalable realtime backend
- Powered by Yjs for industry-standard conflict resolution
Features include:
- Multiplayer Editing with real-time synchronization
- Collaboration with presence and remote cursors
- Conflict Resolution ensuring document consistency across all clients
- Offline Support with automatic synchronization upon reconnection
- Version History with save, list, and restore APIs
- React Lifecycle Safety (StrictMode-safe initialization, automatic cleanup on unmount)
- ... and so much more
Installation
npm install @veltdev/ckeditor-crdt-react @veltdev/ckeditor-crdt @veltdev/react ckeditor5 @ckeditor/ckeditor5-reactDocumentation
- Read the documentation for setup guides and API references.
Use cases
The CKEditor CRDT React library is used to power:
- Collaborative editing tools
- Real-time document workspaces
- Internal wikis and knowledge bases
- Shared meeting notes and agendas
- Any shared, mutable environment
Resources
- Explore multiplayer editing to see features like collaborative text, whiteboards, and data grids.
- Sample Apps: Check out example implementations for various use cases.
Releases
- See the latest changes.
Security
- Velt is SOC2 Type 2 and HIPAA compliant. Learn more
Community
- X: To receive updates, announcements, and general Velt tips.
