API REFERENCE
collaborationRoom
Collaboration room ID for sharing edits and presence. Connecting multiple devices requires remote service configuration.
What does this API do?
Collaboration room ID for sharing edits and presence. Connecting multiple devices requires remote service configuration.
API for Pro features: Real-time collaboration (existing Pro grade retained)
Exact input and result types
collaborationRoom: string| Item | Value |
|---|---|
| JavaScript name | collaborationRoom |
| HTML attribute | collaboration-room |
| Default | undefined |
| Input type | string |
Usage flow
Set this on a property of the Grid element. In HTML, you can also use the collaboration-room attribute. Pass arrays, objects, and callbacks through JavaScript, and use new arrays or objects when applying changes.
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.