API REFERENCE
connectCollabRoom
Starts the configured collaboration room connection and returns synchronization state.
What does this API do?
Starts the configured collaboration room connection and returns synchronization state.
API for Pro features: Real-time collaboration (existing Pro grade retained)
Exact input and result types
connectCollabRoom(opts?: { realtimeUrl?: string; userName?: string; userColor?: string; presence?: boolean; persistence?: 'none' | 'indexeddb' }): Promise<GridSyncStatus>| Arguments | Required | Type |
|---|---|---|
| opts | Optional | { realtimeUrl?: string; userName?: string; userColor?: string; presence?: boolean; persistence?: 'none' | 'indexeddb' } |
The return type is Promise<GridSyncStatus>.
Usage flow
After registering and initializing the Grid element, call grid.connectCollabRoom(…). Read the return value with await. For methods returning a boolean or report, inspect the result before continuing.
Read related types
Feature explanations and examples
- Real-time collaboration
Collaboration shares edits, cursors, and presence among users in the same room. A room name alone does not automatically connect devices over the internet.