@veltdev/lexical-crdt-react
v1.0.2
Published
React hooks and plugin for Velt Lexical CRDT collaboration
Readme
Velt Lexical CRDT React Library
With Velt Lexical CRDT React Library, you can add powerful multiplayer editing and state synchronization features to any React application using Lexical. It wraps the framework-agnostic @veltdev/lexical-crdt core with idiomatic React hooks and a LexicalComposer plugin.
The library provides React-native realtime primitives:
- Hooks and a composer plugin that manage the full collaboration lifecycle for you
- 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 cursors
- Conflict Resolution ensuring document consistency across all clients
- Offline Support with automatic synchronization upon reconnection
- React Lifecycle Safety with automatic setup and cleanup on mount/unmount
- Reactive Sync State (
isLoading,isSynced,status,error) for your UI - ... and so much more
Installation
npm install @veltdev/lexical-crdt @veltdev/lexical-crdt-react @veltdev/react lexical @lexical/react @lexical/yjs yjs react react-domDocumentation
- Read the documentation for setup guides and API references.
Use cases
The Lexical 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.
