API REFERENCE
collaboratorJoined
Emitted when a participant joins the collaboration room.
What does this API do?
Emitted when a participant joins the collaboration room.
API for Pro features: Real-time collaboration (existing Pro grade retained)
Exact input and result types
collaboratorJoined: GridCollaboratorInfoUsage flow
Subscribe with grid.addEventListener('collaboratorJoined', handler). The result is in event.detail, and event names are case-sensitive. Remove subscriptions when disposing of the view.
const controller = new AbortController();
grid.addEventListener('collaboratorJoined', event => {
console.log(event.detail);
}, { signal: controller.signal });
// On view disposal: controller.abort();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.