2020-11-06 18:37:30 +08:00
# CollaborationCursor
2021-01-09 01:02:06 +08:00
[](https://www.npmjs.com/package/@tiptap/extension-collaboration-cursor)
[](https://npmcharts.com/compare/@tiptap/extension-collaboration-cursor?minimal=true)
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’
2020-09-26 17:36:43 +08:00
2020-11-06 04:57:25 +08:00
Open this page in multiple browser windows to test it.
2020-12-04 00:23:54 +08:00
:::pro Pro Extension
2020-12-01 19:03:50 +08:00
We kindly ask you to [sponsor our work ](/sponsor ) when using this extension in production.
2020-11-06 04:57:25 +08:00
:::
2020-10-29 01:05:20 +08:00
## Installation
```bash
2020-10-30 21:24:16 +08:00
# with npm
2020-10-29 01:05:20 +08:00
npm install @tiptap/extension -collaboration-cursor
2020-10-30 21:24:16 +08:00
# with Yarn
2020-10-29 01:05:20 +08:00
yarn add @tiptap/extension -collaboration-cursor
```
2021-02-12 22:02:40 +08:00
This extension requires the [`Collaboration` ](/api/extensions/collaboration ) extension.
2020-10-29 01:05:20 +08:00
## Settings
2020-12-01 19:03:50 +08:00
| Option | Type | Default | Description |
| -------- | ---------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| provider | `Object` | `null` | A Y.js network connection, for example a [y-websocket ](https://github.com/yjs/y-websocket ) instance. |
| user | `Object` | `{ user: null, color: null }` | Attributes of the current user, assumes to have a name and a color, but can be used with any attribute. |
2021-04-21 21:31:11 +08:00
| render | `Function` | … | 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. |
2020-10-29 01:05:20 +08:00
## Commands
2020-12-04 00:05:22 +08:00
| Command | Parameters | Description |
| ------- | ---------- | ------------------------------------------------------------------------------------------------ |
| user | attributes | An object with the attributes of the current user, by default it expects a `name` and a `color` . |
2020-10-29 01:05:20 +08:00
## Source code
2021-04-21 21:31:11 +08:00
[packages/extension-collaboration-cursor/ ](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-collaboration-cursor/ )
2020-10-29 01:05:20 +08:00
## Usage
:::warning Public
The content of this editor is shared with other users.
:::
2021-09-19 05:01:30 +08:00
< tiptap-demo name = "Extensions/CollaborationCursor" hide-source > < / tiptap-demo >
2021-08-26 05:10:20 +08:00
< tiptap-demo name = "Extensions/CollaborationCursor" > < / tiptap-demo >
