tiptap/docs/api/extensions/collaboration-cursor.md

---
description: See other user’s cursors and their name while they type.
icon: account-pin-circle-line
---

# CollaborationCursor
[![Version](https://img.shields.io/npm/v/@tiptap/extension-collaboration-cursor.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-collaboration-cursor)
[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-collaboration-cursor.svg)](https://npmcharts.com/compare/@tiptap/extension-collaboration-cursor?minimal=true)

This extension adds information about all connected users (like their name and a specified color), their current cursor position and their text selection (if there’s one).

Open this page in multiple browser windows to test it.

:::pro Pro Extension
We kindly ask you to [sponsor our work](/sponsor) when using this extension in production.
:::

## Installation
```bash
npm install @tiptap/extension-collaboration-cursor
```

:::warning Are you using Yarn, pNPM, npm 6 or less?
Unfortunately your package manager does not install peer dependencies automatically and you have to install them by your own. Please [see here](https://tiptap.dev/installation/peer-dependencies#tiptapextension-collaboration-cursor) which packages are needed and how to install them.
:::

This extension requires the [`Collaboration`](/api/extensions/collaboration) extension.

## Settings

### provider
A Y.js network provider, for example a [y-websocket](https://github.com/yjs/y-websocket) instance.

Default: `null`

### user
Attributes of the current user, assumes to have a name and a color, but can be used with any attribute. The values are synced with all other connected clients.

Default: `{ user: null, color: null }`

### render
A render function for the cursor, look at [the extension source code](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-collaboration-cursor/) for an example.

## Commands

### updateUser()
Pass an object with updated attributes of the current user. It expects a `name` and a `color`, but you can add additional fields, too.

```js
editor.commands.updateUser({
  name: 'John Doe',
  color: '#000000',
  avatar: 'https://unavatar.io/github/ueberdosis',
})
```

## Source code
[packages/extension-collaboration-cursor/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-collaboration-cursor/)

## Usage
:::warning Public
The content of this editor is shared with other users.
:::
https://embed.tiptap.dev/preview/Extensions/CollaborationCursor?hideSource
https://embed.tiptap.dev/preview/Extensions/CollaborationCursor
-												docs: add descriptions to all extensions

											
										
										
											2021-10-14 06:13:50 +08:00
+								---
 								description: See other user’s cursors and their name while they type.
-												docs: add icons for extensions

											
										
										
											2021-10-15 03:20:21 +08:00
+								icon: account-pin-circle-line
-												docs: add descriptions to all extensions

											
										
										
											2021-10-14 06:13:50 +08:00
+								---
-												update content

											
										
										
											2020-11-06 18:37:30 +08:00
+								# CollaborationCursor
-												make less assumptions about the Y.js provider, fix #70

											
										
										
											2021-01-09 01:02:06 +08:00
+								[![Version](https://img.shields.io/npm/v/@tiptap/extension-collaboration-cursor.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-collaboration-cursor)
 								[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-collaboration-cursor.svg)](https://npmcharts.com/compare/@tiptap/extension-collaboration-cursor?minimal=true)
-												add content to the collaboration cursor extension

											
										
										
											2020-11-06 04:57:25 +08:00
+								This extension adds information about all connected users (like their name and a specified color), their current cursor position and their text selection (if there’s one).
-												add empty extension pages

											
										
										
											2020-09-26 17:36:43 +08:00
-												add content to the collaboration cursor extension

											
										
										
											2020-11-06 04:57:25 +08:00
+								Open this page in multiple browser windows to test it.
-												docs: update content

											
										
										
											2020-12-04 00:23:54 +08:00
+								:::pro Pro Extension
-												docs: update content

											
										
										
											2020-12-01 19:03:50 +08:00
+								We kindly ask you to [sponsor our work](/sponsor) when using this extension in production.
-												add content to the collaboration cursor extension

											
										
										
											2020-11-06 04:57:25 +08:00
+								:::
-												add premium hints everywhere, add premium flags to the navigation, add a license page

											
										
										
											2020-10-29 01:05:20 +08:00
+								## Installation
 								```bash
 								npm install @tiptap/extension-collaboration-cursor
 								```
-												docs: improve peer dependency hints

											
										
										
											2022-12-23 07:00:57 +08:00
+								:::warning Are you using Yarn, pNPM, npm 6 or less?
 								Unfortunately your package manager does not install peer dependencies automatically and you have to install them by your own. Please [see here](https://tiptap.dev/installation/peer-dependencies#tiptapextension-collaboration-cursor) which packages are needed and how to install them.
 								:::
-												docs: update content

											
										
										
											2021-02-12 22:02:40 +08:00
+								This extension requires the [`Collaboration`](/api/extensions/collaboration) extension.
-												add premium hints everywhere, add premium flags to the navigation, add a license page

											
										
										
											2020-10-29 01:05:20 +08:00
+								## Settings
-												docs: make all extenion settings a list

											
										
										
											2021-10-02 07:20:09 +08:00
 								### provider
 								A Y.js network provider, for example a [y-websocket](https://github.com/yjs/y-websocket) instance.
 								Default: `null`
 								### user
 								Attributes of the current user, assumes to have a name and a color, but can be used with any attribute. The values are synced with all other connected clients.
 								Default: `{ user: null, color: null }`
 								### render
 								A render function for the cursor, look at [the extension source code](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-collaboration-cursor/) for an example.
-												add premium hints everywhere, add premium flags to the navigation, add a license page

											
										
										
											2020-10-29 01:05:20 +08:00
 								## Commands
-												docs: make all extenion settings a list

											
										
										
											2021-10-02 07:20:09 +08:00
-												Use the new storage feature for the `CollaborationCursor` extension (#2096)

* extension-collaboration-cursor: make use of the new storage feature, deprecate users command and onUsers callback, clean up

* docs: update the jobs page
											
										
										
											2021-10-28 16:00:16 +08:00
+								### updateUser()
 								Pass an object with updated attributes of the current user. It expects a `name` and a `color`, but you can add additional fields, too.
-												docs: make all extenion settings a list

											
										
										
											2021-10-02 07:20:09 +08:00
 								```js
-												Use the new storage feature for the `CollaborationCursor` extension (#2096)

* extension-collaboration-cursor: make use of the new storage feature, deprecate users command and onUsers callback, clean up

* docs: update the jobs page
											
										
										
											2021-10-28 16:00:16 +08:00
+								editor.commands.updateUser({
-												update people

											
										
										
											2022-05-10 23:51:50 +08:00
+								  name: 'John Doe',
-												Use the new storage feature for the `CollaborationCursor` extension (#2096)

* extension-collaboration-cursor: make use of the new storage feature, deprecate users command and onUsers callback, clean up

* docs: update the jobs page
											
										
										
											2021-10-28 16:00:16 +08:00
+								  color: '#000000',
-												update people

											
										
										
											2022-05-10 23:51:50 +08:00
+								  avatar: 'https://unavatar.io/github/ueberdosis',
-												Use the new storage feature for the `CollaborationCursor` extension (#2096)

* extension-collaboration-cursor: make use of the new storage feature, deprecate users command and onUsers callback, clean up

* docs: update the jobs page
											
										
										
											2021-10-28 16:00:16 +08:00
+								})
-												docs: make all extenion settings a list

											
										
										
											2021-10-02 07:20:09 +08:00
+								```
-												add premium hints everywhere, add premium flags to the navigation, add a license page

											
										
										
											2020-10-29 01:05:20 +08:00
 								## Source code
-												replace link to GitHub repository

											
										
										
											2021-04-21 21:31:11 +08:00
+								[packages/extension-collaboration-cursor/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-collaboration-cursor/)
-												add premium hints everywhere, add premium flags to the navigation, add a license page

											
										
										
											2020-10-29 01:05:20 +08:00
 								## Usage
 								:::warning Public
 								The content of this editor is shared with other users.
 								:::
-												docs: replace embeds with just the URL

											
										
										
											2021-10-19 00:01:47 +08:00
+								https://embed.tiptap.dev/preview/Extensions/CollaborationCursor?hideSource
 								https://embed.tiptap.dev/preview/Extensions/CollaborationCursor