@veltdev/prosemirror-crdt-react
v1.0.2
Published
ProseMirror CRDT React library for Velt
Readme
Velt ProseMirror CRDT React Library
With Velt ProseMirror CRDT React Library, you can add powerful multiplayer editing and state synchronization features to any React application using ProseMirror.
The library provides React-native realtime primitives:
ProseMirrorCrdtEditordrop-in collaborative ProseMirror React componentuseCollaborationhook for managing shared state, sync status, and versionscreateDefaultProseMirrorSchemaready-made schema with lists and highlight support- Shared
undo/redocommands powered by y-prosemirror - 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 and restore APIs
- React Hooks for seamless integration with React components
- ... and so much more
Installation
npm install @veltdev/prosemirror-crdt-react @veltdev/prosemirror-crdt @veltdev/react prosemirror-model prosemirror-schema-basic prosemirror-schema-list prosemirror-state prosemirror-view y-prosemirror yjsDocumentation
- Read the documentation for setup guides and API references.
Use cases
The ProseMirror CRDT React library is used to power:
- Collaborative editing tools
- Real-time document editing
- Shared workspaces
- 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.
