Files
tiptap/docs/src/docPages/api/extensions/collaboration.md
2020-12-01 12:03:50 +01:00

1.3 KiB

Collaboration

The Collaboration extension enables you to collaborate with others on one document. The implementation is based on Y.js by Kevin Jahns, which is the coolest thing to integrate collaborative editing in your project.

:::premium Pro Extension We kindly ask you to sponsor our work when using this extension in production. :::

Installation

# with npm
npm install @tiptap/extension-collaboration yjs y-websocket

# with Yarn
yarn add @tiptap/extension-collaboration yjs y-websocket

Settings

Option Type Default Description
provider Object null A Y.js network connection, for example a y-websocket instance.

Commands

None

Keyboard shortcuts

None

Source code

packages/extension-collaboration/

Usage

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