Vizel API / core/src / VizelCollaborationOptions

Interface: VizelCollaborationOptions

Defined in: packages/core/src/collaboration.ts:62

Options for collaboration state management

Properties

enabled?

optional enabled?: boolean;

Defined in: packages/core/src/collaboration.ts:64

Whether collaboration tracking is enabled (default: true)

---

onConnect?

optional onConnect?: () => void;

Defined in: packages/core/src/collaboration.ts:68

Callback when connected to the collaboration server

Returns

void

---

onDisconnect?

optional onDisconnect?: () => void;

Defined in: packages/core/src/collaboration.ts:70

Callback when disconnected from the collaboration server

Returns

void

---

onError?

optional onError?: (error) => void;

Defined in: packages/core/src/collaboration.ts:77

Callback when an error occurs. The error may be a VizelError — narrow with isVizelError(error) to access the structured code field.

Parameters

Parameter	Type
error	Error

Returns

void

---

onPeersChange?

optional onPeersChange?: (count) => void;

Defined in: packages/core/src/collaboration.ts:79

Callback when the number of connected peers changes

Parameters

Parameter	Type
count	number

Returns

void

---

onSynced?

optional onSynced?: () => void;

Defined in: packages/core/src/collaboration.ts:72

Callback when initial document sync completes

Returns

void

---

user

user: VizelCollaborationUser;

Defined in: packages/core/src/collaboration.ts:66

Current user info for cursor display