Introduction
Yjs is a high-performance CRDT for building collaborative applications that sync automatically.
It exposes its internal CRDT model as shared data types that can be
manipulated concurrently. Shared types are similar to common data types like
Map and Array. They can be manipulated, fire events when changes happen, and
automatically merge without merge conflicts.
Quick Start
This is a working example of how shared types automatically sync. We also have a getting-started guide, API documentation, and lots of live demos with source code.
Editor Support
Yjs supports several popular text and rich-text editors. We are working with other projects to enable collaboration-support through Yjs.
📄️ CodeMirror
Yjs <> CodeMirror Editor Binding
📄️ Milkdown
Make Milkdown collaborative with Yjs.
📄️ Monaco
Make Monaco collaborative with Yjs
📄️ ProseMirror
Shared Editing with the ProseMirror Editor
📄️ Quill
Make Quill collaborative with Yjs.
📄️ Remirror
Make Remirror collaborative with Yjs
📄️ TipTap
Make TipTap collaborative with Yjs
Network Agnostic 📡
Yjs doesn't make any assumptions about the network technology you are using. As long as all changes eventually arrive, the documents will sync. The order in which document updates are applied doesn't matter.
You can integrate Yjs into your existing communication infrastructure, or use one of the several existing network providers that allow you to jump-start your application backend.
Scaling shared editing backends is not trivial. Most shared editing solutions depend on a single source of truth - a central server - to perform conflict resolution. Yjs doesn't need a central source of truth. This enables you to design the backend using ideas from distributed system architecture. Multiple backends can serve the same document to your users. And if one of them fails - no problem - clients can just fall back to your backup servers. This makes scaling your infrastructure much easier.
Another interesting application for Yjs as a data model for decentralized and Local-First software.
Rich Ecosystem 🔥
Yjs is a modular approach that allows the community to make any editor collaborative using any network technology. It has thought-through solutions for almost all shared-editing related problems.
We built a rich ecosystem of extensions around Yjs. There are ready-to-use editor integrations for many popular (rich-)text editors, adapters to different network technologies (like WebRTC, WebSocket, or Hyper), and persistence providers that store document updates in a database.
Unmatched Performance 🚀
Yjs is the fastest CRDT implementation, by far.