tiptap/docs/api/extensions/collaboration.md

# 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
| Option   | Type     | Default     | Description                                                                             |
| -------- | -------- | ----------- | --------------------------------------------------------------------------------------- |
| document | `Object` | `null`      | An initialized Y.js document.                                                           |
| field    | `String` | `'default'` | Name of a Y.js fragment, can be changed to sync multiple fields with one Y.js document. |
| fragment | `Object` | `null`      | A raw Y.js fragment, can be used instead of `document` and `field`.                     |

## Commands
| Command | Parameters | Description           |
| ------- | ---------- | --------------------- |
| undo    | —          | Undo the last change. |
| redo    | —          | Redo the last change. |

## Keyboard shortcuts
### Undo
* Windows/Linux: `Control`&nbsp;`Z`
* macOS: `Cmd`&nbsp;`Z`

### Redo
* Windows/Linux: `Shift`&nbsp;`Control`&nbsp;`Z` or `Control`&nbsp;`Y`
* macOS: `Shift`&nbsp;`Cmd`&nbsp;`Z` or `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.
:::
<tiptap-demo name="Extensions/Collaboration" hide-source></tiptap-demo>
<tiptap-demo name="Extensions/Collaboration"></tiptap-demo>
-												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
-												add support for raw Y.js fragments to the collaboration extension

											
										
										
											2021-01-12 01:37:30 +08:00
+								| Option   | Type     | Default     | Description                                                                             |
 								| -------- | -------- | ----------- | --------------------------------------------------------------------------------------- |
 								| document | `Object` | `null`      | An initialized Y.js document.                                                           |
 								| field    | `String` | `'default'` | Name of a Y.js fragment, can be changed to sync multiple fields with one Y.js document. |
 								| fragment | `Object` | `null`      | A raw Y.js fragment, can be used instead of `document` and `field`.                     |
-												add content to the collaboration extension page

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

											
										
										
											2020-12-04 00:23:54 +08:00
+								| Command | Parameters | Description           |
 								| ------- | ---------- | --------------------- |
 								| undo    | —          | Undo the last change. |
 								| redo    | —          | Redo the last change. |
-												add content to the collaboration extension page

											
										
										
											2020-09-27 02:58:58 +08:00
 								## Keyboard shortcuts
-												docs: update content

											
										
										
											2020-12-04 00:23:54 +08:00
+								### Undo
 								* Windows/Linux: `Control`&nbsp;`Z`
 								* macOS: `Cmd`&nbsp;`Z`
 								### Redo
 								* Windows/Linux: `Shift`&nbsp;`Control`&nbsp;`Z` or `Control`&nbsp;`Y`
 								* macOS: `Shift`&nbsp;`Cmd`&nbsp;`Z` or `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.
 								:::
-												test something

											
										
										
											2021-09-19 04:58:38 +08:00
+								<tiptap-demo name="Extensions/Collaboration" hide-source></tiptap-demo>
-												replace demo component with custom element

											
										
										
											2021-08-26 05:10:20 +08:00
+								<tiptap-demo name="Extensions/Collaboration"></tiptap-demo>