API REFERENCE
realtimeUrl
WebSocket URL for remote collaboration. When omitted, collaboration is limited to a same-page/process demo scope.
What does this API do?
WebSocket URL for remote collaboration. When omitted, collaboration is limited to a same-page/process demo scope.
API for Pro features: Real-time collaboration (existing Pro grade retained)
Exact input and result types
realtimeUrl: string| Item | Value |
|---|---|
| JavaScript name | realtimeUrl |
| HTML attribute | realtime-url |
| Default | undefined |
| Input type | string |
Usage flow
Set this on a property of the Grid element. In HTML, you can also use the realtime-url 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.