2020-09-26 17:36:43 +08:00
# Collaboration Cursor
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).
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.
:::premium 💖 Pro Extension
We kindly ask you to sponsor us, before using this extension in production. [Read more ](/sponsor )
:::
::: warning Use with Collaboration
This extension requires the [`Collaboration` ](/api/extensions/collaboration ) extension.
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
```
## Settings
| Option | Type | Default | Description |
| -------- | ---- | ------- | ----------- |
| provider | | | |
| type | | | |
## Commands
2020-11-03 23:43:35 +08:00
| Command | Parameters | Description |
| ------- | ------------- | ------------------------------------------------------------------------ |
| user | name< br > color | The name of the current user.< br > The color of the current user’ s cursor. |
2020-10-29 01:05:20 +08:00
## Source code
[packages/extension-collaboration-cursor/ ](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-collaboration-cursor/ )
## Usage
:::warning Public
The content of this editor is shared with other users.
:::
2020-11-06 04:57:25 +08:00
< demo name = "Extensions/CollaborationCursor" highlight = "11,48-52" / >