# connectCollabRoom

Starts the configured collaboration room connection and returns synchronization state.

Canonical: https://grid.syidax.com/docs/methods/connectCollabRoom/

<a id="meaning"></a>

## 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)

<a id="contract"></a>

## Exact input and result types

```typescript
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>`.

<a id="usage"></a>

## 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.

<a id="types"></a>

## Read related types

- [GridSyncStatus](https://grid.syidax.com/docs/types/GridSyncStatus.md)

<a id="recipes"></a>

## Feature explanations and examples

- [Real-time collaboration](https://grid.syidax.com/docs/features/collaboration.md) — Collaboration shares edits, cursors, and presence among users in the same room. A room name alone does not automatically connect devices over the internet.