2020-09-26 17:36:43 +08:00
|
|
|
|
# Collaboration Cursor
|
|
|
|
|
|
|
2020-10-29 01:05:20 +08:00
|
|
|
|
:::premium Premium Extension
|
2020-10-29 04:53:40 +08:00
|
|
|
|
Using this in production requires a **tiptap pro** license. [Read more](/sponsor)
|
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.
|
|
|
|
|
|
:::
|
|
|
|
|
|
<demo name="Extensions/CollaborationCursor" highlight="" />
|
