Yjs Best Practices

Comprehensive guide for implementing real-time collaborative applications with Yjs — the high-performance CRDT framework. Contains 24 rules across 8 categories covering document lifecycle, shared types, providers, editor bindings, awareness, undo/redo, common pitfalls, and debugging.

When to Apply

Reference these guidelines when:

• Creating or managing Y.Doc instances for collaborative documents
• Using shared types (Y.Text, Y.Array, Y.Map, Y.XmlFragment) for synced data
• Setting up network providers (y-websocket, y-webrtc) or persistence (y-indexeddb)
• Integrating Yjs with editors (TipTap, ProseMirror, CodeMirror, Quill, Monaco)
• Implementing user presence and cursor awareness
• Adding undo/redo to collaborative editing
• Debugging sync issues, state vector mismatches, or update encoding

Rule Categories by Priority