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

62 lines
2.2 KiB
Markdown
Raw Normal View History

---
description: See other users cursors and their name while they type.
2021-10-15 03:20:21 +08:00
icon: account-pin-circle-line
---
2020-11-06 18:37:30 +08:00
# 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 theres one).
2020-09-26 17:36:43 +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.
:::
## Installation
```bash
2020-10-30 21:24:16 +08:00
# with npm
npm install @tiptap/extension-collaboration-cursor
2020-10-30 21:24:16 +08:00
# with Yarn
yarn add @tiptap/extension-collaboration-cursor
```
2021-02-12 22:02:40 +08:00
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
### user()
An object with the attributes of the current user. It expects a `name` and a `color`, but you can add additional fields, too.
```js
editor.commands.user({ name: 'Philipp Kühn', color: '#000000' })
```
## 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/)
## Usage
:::warning Public
The content of this editor is shared with other users.
:::
2021-10-19 00:01:47 +08:00
https://embed.tiptap.dev/preview/Extensions/CollaborationCursor?hideSource
https://embed.tiptap.dev/preview/Extensions/CollaborationCursor