Vizel API / react/src / UseVizelCollaborationResult

Interface: UseVizelCollaborationResult

Defined in: packages/react/src/hooks/useVizelCollaboration.ts:23

Collaboration hook result

Properties

connect

connect: () => void;

Defined in: packages/react/src/hooks/useVizelCollaboration.ts:33

Connect to the collaboration server

Returns

void

---

disconnect

disconnect: () => void;

Defined in: packages/react/src/hooks/useVizelCollaboration.ts:35

Disconnect from the collaboration server

Returns

void

---

error

error: Error | null;

Defined in: packages/react/src/hooks/useVizelCollaboration.ts:31

Last error that occurred

---

isConnected

isConnected: boolean;

Defined in: packages/react/src/hooks/useVizelCollaboration.ts:25

Whether connected to the collaboration server

---

isSynced

isSynced: boolean;

Defined in: packages/react/src/hooks/useVizelCollaboration.ts:27

Whether the initial document sync is complete

---

peerCount

peerCount: number;

Defined in: packages/react/src/hooks/useVizelCollaboration.ts:29

Number of currently connected peers (including self)

---

updateUser

updateUser: (user) => void;

Defined in: packages/react/src/hooks/useVizelCollaboration.ts:37

Update the current user's cursor information

Parameters

Parameter	Type
user	VizelCollaborationUser

Returns

void