Real-time collaboration
Real-time collaboration extensions let several people edit a document at the same time and show where the others are typing.
When you use them
- Editing together. Collaboration syncs the editor with a Y.js document, so several people can edit it at the same time.
- Seeing each other. Collaboration caret shows the carets, selections, names, and colors of the other people while they type.
How they work
- They need a sync server. Connect the editor to the Document Server, in Tiptap Cloud or on-premises, or to the open source Hocuspocus.
- Collaboration caret needs Collaboration. It takes the Y.js provider and the current user's name and color. It has no default styles, so you add CSS for the carets.
- Collaboration has its own undo and redo. Turn off Undo and redo, in the StarterKit with
undoRedo: false. - You add them yourself. Neither is part of the StarterKit.
Related
- Install Collaboration with the Document Server.
- Document helpers include Unique ID, which you mount after the collaboration provider has synced.