tiptap/docs/api/extensions/collaboration.md

---
description: Collaborative text editing can be fricking complex, but it doesn’t have to be that way.
icon: user-voice-line
---

# Collaboration
[![Version](https://img.shields.io/npm/v/@tiptap/extension-collaboration.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-collaboration)
[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-collaboration.svg)](https://npmcharts.com/compare/@tiptap/extension-collaboration?minimal=true)

The Collaboration extension enables you to collaborate with others in a single document. The implementation is based on [Y.js by Kevin Jahns](https://github.com/yjs/yjs), which is the coolest thing to [integrate collaborative editing](/guide/collaborative-editing) in your project.

The history works totally different in a collaborative editing setup. If you undo a change, you don’t want to undo changes of other users. To handle that behaviour this extension provides an own `undo` and `redo` command. Don’t load the default [`History`](/api/extensions/history) extension together with the Collaboration extension to avoid conflicts.

:::pro Pro Extension
We kindly ask you to [sponsor our work](/sponsor) when using this extension in production.
:::

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

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

## Settings

### document
An initialized Y.js document.

Default: `null`

```js
Collaboration.configure({
  document: new Y.Doc(),
})
```

### field
Name of a Y.js fragment, can be changed to sync multiple fields with one Y.js document.

Default: `'default'`

```js
Collaboration.configure({
  document: new Y.Doc(),
  field: 'title',
})
```

### fragment
A raw Y.js fragment, can be used instead of `document` and `field`.

Default: `null`

```js
Collaboration.configure({
  fragment: new Y.Doc().getXmlFragment('body'),
})
```

## Commands
The `Collboration` extension comes with its own history extension. Make sure to disable the default extension, if you’re working with the `StarterKit`.

### undo()
Undo the last change.

```js
editor.commands.undo()
```
### redo()
Redo the last change.

```js
editor.commands.redo()
```

## Keyboard shortcuts
| Command | Windows/Linux                                         | macOS                                         |
| ------- | ----------------------------------------------------- | --------------------------------------------- |
| undo()  | `Control`&nbsp;`Z`                                    | `Cmd`&nbsp;`Z`                                |
| redo()  | `Shift`&nbsp;`Control`&nbsp;`Z`<br>`Control`&nbsp;`Y` | `Shift`&nbsp;`Cmd`&nbsp;`Z`<br>`Cmd`&nbsp;`Y` |

## Source code
[packages/extension-collaboration/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-collaboration/)

## Usage
:::warning Public
The content of this editor is shared with other users.
:::
https://embed.tiptap.dev/preview/Extensions/Collaboration?hideSource
https://embed.tiptap.dev/preview/Extensions/Collaboration
-												docs: add descriptions to all extensions

											
										
										
											2021-10-14 06:13:50 +08:00
+								---
-												docs: update content

											
										
										
											2021-10-16 04:48:57 +08:00
+								description: Collaborative text editing can be fricking complex, but it doesn’t have to be that way.
-												docs: add icons for extensions

											
										
										
											2021-10-15 03:20:21 +08:00
+								icon: user-voice-line
-												docs: add descriptions to all extensions

											
										
										
											2021-10-14 06:13:50 +08:00
+								---
-												improve the extensions documentation

											
										
										
											2020-08-20 21:33:16 +08:00
+								# Collaboration
-												docs: update content

											
										
										
											2020-12-04 00:23:54 +08:00
+								[![Version](https://img.shields.io/npm/v/@tiptap/extension-collaboration.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-collaboration)
 								[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-collaboration.svg)](https://npmcharts.com/compare/@tiptap/extension-collaboration?minimal=true)
 								The Collaboration extension enables you to collaborate with others in a single document. The implementation is based on [Y.js by Kevin Jahns](https://github.com/yjs/yjs), which is the coolest thing to [integrate collaborative editing](/guide/collaborative-editing) in your project.
-												update content

											
										
										
											2020-10-28 23:49:44 +08:00
-												docs: add content

											
										
										
											2020-12-03 23:52:54 +08:00
+								The history works totally different in a collaborative editing setup. If you undo a change, you don’t want to undo changes of other users. To handle that behaviour this extension provides an own `undo` and `redo` command. Don’t load the default [`History`](/api/extensions/history) extension together with the Collaboration extension to avoid conflicts.
-												docs: update content

											
										
										
											2020-12-04 00:23:54 +08:00
+								:::pro Pro Extension
-												docs: update content

											
										
										
											2020-12-01 19:03:50 +08:00
+								We kindly ask you to [sponsor our work](/sponsor) when using this extension in production.
-												update content

											
										
										
											2020-10-28 23:49:44 +08:00
+								:::
-												add content to the collaboration extension page

											
										
										
											2020-09-27 02:58:58 +08:00
 								## Installation
 								```bash
-												update content

											
										
										
											2020-10-30 21:24:16 +08:00
+								# with npm
-												docs: update content

											
										
										
											2020-12-01 19:03:50 +08:00
+								npm install @tiptap/extension-collaboration yjs y-websocket
-												add content to the collaboration extension page

											
										
										
											2020-09-27 02:58:58 +08:00
-												update content

											
										
										
											2020-10-30 21:24:16 +08:00
+								# with Yarn
-												docs: update content

											
										
										
											2020-12-01 19:03:50 +08:00
+								yarn add @tiptap/extension-collaboration yjs y-websocket
-												add content to the collaboration extension page

											
										
										
											2020-09-27 02:58:58 +08:00
+								```
 								## Settings
-												docs: make all extenion settings a list

											
										
										
											2021-10-02 07:20:09 +08:00
 								### document
 								An initialized Y.js document.
 								Default: `null`
 								```js
 								Collaboration.configure({
 								  document: new Y.Doc(),
 								})
 								```
 								### field
 								Name of a Y.js fragment, can be changed to sync multiple fields with one Y.js document.
 								Default: `'default'`
 								```js
 								Collaboration.configure({
 								  document: new Y.Doc(),
 								  field: 'title',
 								})
 								```
 								### fragment
 								A raw Y.js fragment, can be used instead of `document` and `field`.
 								Default: `null`
 								```js
 								Collaboration.configure({
 								  fragment: new Y.Doc().getXmlFragment('body'),
 								})
 								```
-												add content to the collaboration extension page

											
										
										
											2020-09-27 02:58:58 +08:00
 								## Commands
-												docs: make all extenion settings a list

											
										
										
											2021-10-02 07:20:09 +08:00
+								The `Collboration` extension comes with its own history extension. Make sure to disable the default extension, if you’re working with the `StarterKit`.
 								### undo()
 								Undo the last change.
 								```js
 								editor.commands.undo()
 								```
 								### redo()
 								Redo the last change.
 								```js
 								editor.commands.redo()
 								```
-												add content to the collaboration extension page

											
										
										
											2020-09-27 02:58:58 +08:00
 								## Keyboard shortcuts
-												docs: make all extension keyboard shortcuts a table

											
										
										
											2021-10-02 05:13:49 +08:00
+								| Command | Windows/Linux                                         | macOS                                         |
 								| ------- | ----------------------------------------------------- | --------------------------------------------- |
 								| undo()  | `Control`&nbsp;`Z`                                    | `Cmd`&nbsp;`Z`                                |
 								| redo()  | `Shift`&nbsp;`Control`&nbsp;`Z`<br>`Control`&nbsp;`Y` | `Shift`&nbsp;`Cmd`&nbsp;`Z`<br>`Cmd`&nbsp;`Y` |
-												add content to the collaboration extension page

											
										
										
											2020-09-27 02:58:58 +08:00
 								## Source code
-												replace link to GitHub repository

											
										
										
											2021-04-21 21:31:11 +08:00
+								[packages/extension-collaboration/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-collaboration/)
-												add content to the collaboration extension page

											
										
										
											2020-09-27 02:58:58 +08:00
 								## Usage
-												wording

											
										
										
											2020-09-27 03:04:33 +08:00
+								:::warning Public
 								The content of this editor is shared with other users.
 								:::
-												docs: replace embeds with just the URL

											
										
										
											2021-10-19 00:01:47 +08:00
+								https://embed.tiptap.dev/preview/Extensions/Collaboration?hideSource
 								https://embed.tiptap.dev/preview/Extensions/Collaboration