🔧
API
🧪
Tutorials
Awareness & Presence
Propagating awareness information such as presence & cursor locations.
Awareness features are an integral part of collaborative applications. In the last chapter, we made an editor collaborative by syncing content among all users. But we can communicate more information to help our users work together. By sharing cursor locations and presence information, we help our users to actively work together. Most applications also assign a unique name and color to each user. This kind of information can be generally classified as "Awareness" information. It gives you hints about what other users are currently doing.
We could share even more awareness information like the mouse position of each user, or a live video recording of each user. But when we share too much information, we distract our users from the task at hand. So it is important to find the right balance, that makes sense for your application.
Sharing no awareness information at all is also an option. Then skip this chapter, or come back later.
Awareness information isn't stored in the Yjs document, as it doesn't need to be persisted across sessions. Instead, we use a tiny state-based Awareness CRDT that propagates JSON objects to all users. When you go offline, your own awareness state is automatically deleted and all users are notified that you went offline. While this feature is optional, it is recommended that network providers implement the awareness protocol to make it easier to switch providers. All our network providers implement the Awareness CRDT.
In this part of the tutorial we use the Awareness CRDT to render remote cursor locations in the Quill editor. Furthermore, we implement a basic interface to render a list of remote users and assign them a user-name that can be updated in real-time.
Quick start: Awareness CRDT
The following example shows how you retrieve the Awareness CRDT from the network provider. Then we can set some properties that are propagated to all users. We define the
"user" property to set the name and preferred color for the current user.1
// All of our network providers implement the awareness crdt
2
const awareness = provider.awareness
3
4
// You can observe when a user updates their awareness information
5
awareness.on('change', changes => {
6
// Whenever somebody updates their awareness information,
7
// we log all awareness information from all users.
8
console.log(Array.from(awareness.getStates().values()))
9
})
10
11
// You can think of your own awareness information as a key-value store.
12
// We update our "user" field to propagate relevant user information.
13
awareness.setLocalStateField('user', {
14
// Define a print name that should be displayed
15
name: 'Emmanuelle Charpentier',
16
// Define a color that should be associated to the user:
17
color: '#ffb61e' // should be a hex color
18
})
Copied!
The fields of the Awareness CRDT are not standardized. You can set any JSON-encodable value. The editor bindings commonly use the
"cursor" field to communicate cursor locations. They use the "user" field to render the cursor object in a unique color, with the user name above the cursor location.
Example of y-quill using different colors.
All editor bindings that support rendering cursor information accept an awareness instance to render cursor information. If the
"user" awareness field is unspecified, then the editor binding will render the cursor in a default color using a random user name.1
const binding = new QuillBinding(ytext, quill, provider.awareness)
Copied!
For now, we have covered everything we need to know to continue with our tutorial. The complete API documentation for the Awareness CRDT is available in a separate section:
Adding common awareness features to our collaborative editor
In the below live-code example, I added common awareness features to our editor project. It assigns a random color and a random user-name to each user using the
do_username npm package. Furthermore, it renders all present users in a list in their respective colors.Copy link
Edit on GitHub