syncStatusChanged

What does this API do?

Emitted when collaboration synchronization changes. Distinguish connection state from completed persistent server saving.

API for Pro features: Real-time collaboration (existing Pro grade retained)

Exact input and result types

syncStatusChanged: { status: GridSyncStatus }

Usage flow

Subscribe with grid.addEventListener('syncStatusChanged', 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('syncStatusChanged', event => {
  console.log(event.detail);
}, { signal: controller.signal });
// On view disposal: controller.abort();

Read related types

• GridSyncStatus

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.