Vizel API / core/src / VizelCollaborationProvider

Interface: VizelCollaborationProvider

Defined in: packages/core/src/collaboration-provider.ts:10

Minimal collaboration-provider interface.

The Yjs Y.Doc + connection-provider pair is the reference implementation. Adapters for Liveblocks, Convex, or custom WebSocket protocols wrap their native handles into this shape. Vizel's editor factory consumes this object to wire the History extension off and connect Tiptap's collaboration extensions.

Properties

connect

readonly connect: () => () => void;

Defined in: packages/core/src/collaboration-provider.ts:22

Connect the provider to the editor. Returns a disposer that disconnects the provider and releases any open WebSocket / network resources. The editor invokes this exactly once during creation and the disposer exactly once during destruction.

Returns

() => void

---

kind

readonly kind: string;

Defined in: packages/core/src/collaboration-provider.ts:15

Discriminant for downstream consumers. The reference Yjs adapter sets kind: "yjs"; other providers use their own literal.