mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-12-22 16:17:50 +08:00
7cf17d0b0c
* Add support for custom cursor builders * Add documentation for selectionRender --------- Co-authored-by: Ben Lewis <ben@engageli.com>
63 lines
2.3 KiB
Markdown
63 lines
2.3 KiB
Markdown
---
|
||
description: See other user’s cursors and their name while they type.
|
||
icon: account-pin-circle-line
|
||
---
|
||
|
||
# CollaborationCursor
|
||
[](https://www.npmjs.com/package/@tiptap/extension-collaboration-cursor)
|
||
[](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.
|
||
|
||
## Installation
|
||
```bash
|
||
npm install @tiptap/extension-collaboration-cursor
|
||
```
|
||
|
||
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.
|
||
|
||
### selectionRender
|
||
A render function for the selection, 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
|
||
|
||
!!tiptap-collab-cta
|