# UseCollaborationReturn

**Kind:** Interface

**Source:** [`atloria-monorepo/apps/web/src/hooks/useCollaboration.ts`](https://github.com/sherkety/atloria/blob/main/atloria-monorepo/apps/web/src/hooks/useCollaboration.ts#L78)

Return value of the useCollaboration hook

## Properties

| Property | Type |
|---|---|
| `ydoc` | `Y.Doc | null` |
| `ytext` | `Y.Text | null` |
| `awareness` | `awarenessProtocol.Awareness | null` |
| `synced` | `boolean` |
| `activeUsers` | `CollaborationUser[]` |
| `connectionStatus` | `ConnectionStatus` |
| `error` | `Error | null` |
| `updateCursor` | `(cursor: CursorPosition) => void` |
| `updateSelection` | `(selection: SelectionRange) => void` |
| `disconnect` | `() => void` |
| `reconnect` | `() => void` |
| `version` | `number` |
