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

1.5 KiB
Raw Blame History

Collaboration Cursor

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).

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 :::

::: warning Use with Collaboration This extension requires the Collaboration extension. :::

Installation

# with npm
npm install @tiptap/extension-collaboration-cursor

# with Yarn
yarn add @tiptap/extension-collaboration-cursor

Settings

Option Type Default Description
provider
type

Commands

Command Parameters Description
user name
color
The name of the current user.
The color of the current users cursor.

Source code

packages/extension-collaboration-cursor/

Usage

:::warning Public The content of this editor is shared with other users. :::