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

typescript
collaboratorJoined: GridCollaboratorInfo

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

javascript
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