YjsPresenceManager

Manages presence signaling, view/edit tracking, and session state for collaborative editing.

Tracks which documents you're viewing and editing, signals state to the server, and receives session updates with active participants.

Creating an instance

Use the same clientId and connId values as your YjsDocumentManager.


import { YjsPresenceManager } from "@stratasync/y-doc";

const presenceManager = new YjsPresenceManager({
  clientId: "client-abc-123",
  connId: "conn-xyz-456",
});

PresenceManagerConfig

Property	Type	Description
`clientId`	`string`

Property	Type	Description
`clientId`	`string`

YjsPresenceManager: Manages presence... · Strata Sync


import type { DocumentKey } from "@stratasync/y-doc";

const docKey: DocumentKey = {
  entityType: "Task",
  entityId: "task-123",
  fieldName: "description",
};

presenceManager.startViewing(docKey);


import type { SessionState } from "@stratasync/y-doc";

const session: SessionState | null = presenceManager.getSessionState(docKey);

if (session) {
  const activeCount = session.participants.filter((p) => p.isEditing).length;
}

Property	Type	Description
`active`	`boolean`	Whether the session is active (at least one participant).
`participants`	`SessionParticipant[]`	List of participants.

Property	Type	Description
`userId`	`string`	The participant's user ID.
`isEditing`	`boolean`	Whether the participant is editing (focused).


User opens document   --> startViewing()  --> doc_view "start" sent
User clicks editor    --> focus()         --> doc_focus "focus" sent
User clicks elsewhere --> blur()          --> doc_focus "blur" sent
User closes document  --> stopViewing()   --> doc_view "stop" sent


import { YjsPresenceManager } from "@stratasync/y-doc";
import type { DocumentKey } from "@stratasync/y-doc";

const presenceManager = new YjsPresenceManager({
  clientId: "client-123",
  connId: "conn-456",
});

presenceManager.setTransport(yjsTransport);

const docKey: DocumentKey = {
  entityType: "Task",
  entityId: "task-abc",
  fieldName: "description",
};

const unsubscribe = presenceManager.onSessionStateChange(docKey, (session) => {
  const editors = session.participants.filter((p) => p.isEditing);
  updateUI({ activeEditors: editors.length, isActive: session.active });
});

presenceManager.startViewing(docKey);
presenceManager.focus(docKey);
presenceManager.blur(docKey);
presenceManager.stopViewing(docKey);
unsubscribe();

YjsPresenceManager

Creating an instance

PresenceManagerConfig

YjsPresenceManager

Creating an instance

PresenceManagerConfig

Setting the transport

API reference

startViewing

stopViewing

focus

blur

isViewing

isEditing

getSessionState

SessionState

SessionParticipant

onSessionStateChange

cleanup

Presence lifecycle

Full example