@veltdev/codemirror-crdt
Version:
CodeMirror CRDT library for Velt
59 lines (38 loc) • 2 kB
Markdown
# Velt CodeMirror CRDT Core Library
With Velt CodeMirror CRDT Core Library, you can add powerful multiplayer code editing and state synchronization features to any JavaScript application using CodeMirror. Works with Angular, Vue, Svelte, Solid, and Vanilla JS.
The library provides **framework-agnostic realtime primitives**:
- Universal API for managing shared state
- Fully-managed on a scalable realtime backend
- Powered by Yjs for industry-standard conflict resolution
**Features include:**
- **Multiplayer Code Editing** with real-time character-by-character synchronization
- **Realtime Presence** to see other users' cursors and selections
- **Conflict Resolution** ensuring data consistency across all clients
- **Offline Support** with automatic synchronization upon reconnection
- **Cross-Framework Support** (Angular, Vue, Svelte, Solid, Vanilla JS)
- **Custom Styling** for remote cursors and selection highlights
- ... and so much more
## Installation
```bash
npm install @veltdev/codemirror-crdt @veltdev/client
```
## Documentation
* Read the [documentation](https://docs.velt.dev/realtime-collaboration/crdt/setup/codemirror) for setup guides and API references.
## Use cases
The CodeMirror CRDT library is used to power:
* Cloud IDEs and playgrounds
* Technical interview platforms
* Collaborative query editors (SQL, GraphQL)
* Shared configuration or JSON editors
* Educational coding tools
* Any shared, mutable code environment
## Resources
* Explore [multiplayer editing](https://velt.dev/libraries/codemirror) to see features like collaborative text, whiteboards, and data grids.
* [Sample Apps](https://velt.dev/examples): Check out example implementations for various use cases.
## Releases
* See the [latest changes](https://docs.velt.dev/release-notes/).
## Security
* Velt is SOC2 Type 2 and HIPAA compliant. [Learn more](https://velt.dev/security)
## Community
* [X](https://x.com/veltjs): To receive updates, announcements,
and general Velt tips.