Collaboration

Collaboration & history

Collaboration

Multiple people can edit the same design at once, with live presence. Collaboration is a paid capability, it activates only when the plan grants it (see Plans & entitlements).

Enable it#

Pass a collaboration config to the editor:

tsxStudio.tsx

<EmailEditor
  config={{
    collaboration: {
      sessionId: "design-42", // everyone on the same id shares a session
      user: { id: "u_1", name: "Sam", color: "#2f6df6" }, showPresence: true                    // show collaborator avatars/cursors
    }
  }}
/>

Prop	Type	Default	Description
`sessionId`	string	-	Editors sharing this id edit the same design.
`user`	{ id, name, color? }	-	Identity shown to other collaborators.
`adapter`	MailkaroCollaborationAdapter	-	Transport for sync. Omit to use the built-in Yjs broadcast adapter (same-browser/tab demo); provide your own for cross-network sync (e.g. a Yjs WebSocket provider).
`showPresence`	boolean	true	Show live collaborator presence (who's here, what they've selected). Pass `false` to hide it.

If the plan doesn't grant collaboration, the config is ignored and the editor runs solo, nothing is unlocked client-side.