spec 1 linked patterns checked
Yjs Docs: Awareness API
Documents the awareness protocol as a network-agnostic CRDT for user status, cursor location, username, and email address, with local state updates and remote state-change listening.
Read with a purpose
What this source can teach
Use this source to check a technical or accessibility requirement against its exact wording and scope.
- Start with the original. Open the source and find the guidance or example relevant to your task.
- Trace the connection. Use the claim notes below to see how this site applies the source to specific patterns.
- Check the setting. Compare the source's platform, people, and constraints with your own decision.
Pattern Decisions This Source Supports
| Pattern | Supported decision | Required contract | Claim note |
|---|---|---|---|
| Live cursors | Choose live cursors when users need immediate spatial awareness of other collaborators' current pointer, caret, selection, viewport, or focus inside the same shared surface. | Sending cursor data updates ephemeral awareness state with coordinate, target, viewport, selection, identity, color, timestamp, and visibility preference, not the saved document content. | Yjs awareness API documents user status, cursor location, username, and email address as network-agnostic CRDT state. |
Evidence Role
This source is treated as spec evidence. Its value comes from the specific claims and setting described above.
Publisher: Yjs Docs. Last checked: .