Yarray

YArray is a data type in Yjs for representing a shared, ordered list of elements in real-time collaborative applications. It is implemented as a CRDT-based array that can be edited by multiple clients concurrently, with changes synchronized across all participants to reach a consistent final state.

It is constructed within a Y.Doc and participates in the document's transaction model. Elements stored in a YArray may be primitives or nested Yjs types such as Y.Map or Y.Text; modifications are performed through operations like insert, delete, or splice, typically within a transaction. Observers can subscribe to changes to react in UI or business logic.

Internally, YArray uses the CRDT principles of Yjs to merge concurrent edits without conflicts. Updates are encoded as lightweight operations that are broadcast to other clients, allowing efficient synchronization even in large documents.

Typical use cases include collaborative editing of lists, task boards, or structured data where the order of items matters and concurrent edits are likely.

See also: CRDT, Yjs, Y.Doc, YMap, YText.